diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/bdrc/2023-08-08 | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/bdrc/2023-08-08')
| -rw-r--r-- | data/zh_cn/bdrc/2023-08-08/api-docs.php | 4397 |
1 files changed, 4397 insertions, 0 deletions
diff --git a/data/zh_cn/bdrc/2023-08-08/api-docs.php b/data/zh_cn/bdrc/2023-08-08/api-docs.php new file mode 100644 index 0000000..7153a03 --- /dev/null +++ b/data/zh_cn/bdrc/2023-08-08/api-docs.php @@ -0,0 +1,4397 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'BDRC', + 'version' => '2023-08-08', + ], + 'directories' => [ + [ + 'id' => 223078, + 'title' => '资源分类管理', + 'type' => 'directory', + 'children' => [ + 'DeleteResourceCategory', + 'UpdateResourceCategory', + 'ListResourceCategories', + 'ListResourceCategories', + 'GetResourceCategory', + 'CreateResourceCategory', + ], + ], + [ + 'id' => 223084, + 'title' => '消息中心', + 'type' => 'directory', + 'children' => [ + 'ListMessages', + 'GetMessage', + ], + ], + [ + 'id' => 223087, + 'title' => '保护策略中心', + 'type' => 'directory', + 'children' => [ + 'ListProtectionPolicyApplications', + 'UpdateProtectionPolicy', + 'ListProtectionPolicies', + 'GetProtectionPolicy', + 'DeleteProtectionPolicy', + 'CreateProtectionPolicy', + ], + ], + [ + 'id' => 223094, + 'title' => '资源中心', + 'type' => 'directory', + 'children' => [ + 'UpdateResources', + 'EnableCheckResource', + 'EnableCheckProduct', + 'DisableCheckResource', + 'DisableCheckProduct', + 'CheckRules', + 'DescribeRules', + 'DescribeCheckDetails', + 'DescribeResources', + 'DescribeProducts', + 'DescribeTopRiskyResources', + 'DescribeProductDataRedundancyTypeStat', + ], + ], + [ + 'id' => 223107, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DescribeTasks', + 'DescribeTask', + 'CloseBdrcService', + 'GetBdrcService', + 'OpenBdrcService', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DeleteResourceCategory' => [ + 'summary' => '删除资源分类。', + 'path' => '/api/v1/resource-categories/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253831', + 'abilityTreeNodes' => [ + 'FEATUREbdrcVNSW9V', + 'FEATUREbdrcTWEWJD', + 'FEATUREbdrcI7HVLO', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceCategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源分类ID', + 'type' => 'string', + 'required' => true, + 'example' => 'rc-123****7890', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '8724BC18-904D-5A0D-BFF4-F0554F0037E7', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8724BC18-904D-5A0D-BFF4-F0554F0037E7\\"\\n}","type":"json"}]', + 'title' => '删除资源分类', + ], + 'UpdateResourceCategory' => [ + 'summary' => '更新资源分类。', + 'path' => '/api/v1/resource-categories/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253832', + 'abilityTreeNodes' => [ + 'FEATUREbdrcVNSW9V', + 'FEATUREbdrcTWEWJD', + 'FEATUREbdrcI7HVLO', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceCategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源分类ID', + 'type' => 'string', + 'required' => true, + 'example' => 'rc-123****7890', + ], + ], + [ + 'name' => 'ResourceCategoryName', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源分类名', + 'type' => 'string', + 'required' => false, + 'example' => 'My***ResourceCategory', + ], + ], + [ + 'name' => 'ResourceMatcher', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源匹配器', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "type": "BOOL",'."\n" + .' "operator": "AND",'."\n" + .' "values": ['."\n" + .' {'."\n" + .' "type": "TAG",'."\n" + .' "operator": "EQUAL",'."\n" + .' "key": "key0",'."\n" + .' "values": ['."\n" + .' "value0"'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "type": "TAG",'."\n" + .' "operator": "KEY_EXIST",'."\n" + .' "key": "key1"'."\n" + .' },'."\n" + .' {'."\n" + .' "type": "TAG",'."\n" + .' "operator": "KEY_EXIST_NOT_EQUAL",'."\n" + .' "key": "key2",'."\n" + .' "values": ['."\n" + .' "value2-wrong"'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '700683DE-0154-56D4-8D76-3B7A2C2C7DF9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"700683DE-0154-56D4-8D76-3B7A2C2C7DF9\\"\\n}","type":"json"}]', + 'title' => '更新资源分类', + ], + 'ListResourceCategories' => [ + 'summary' => '获取资源分类列表。', + 'path' => '/api/v1/resource-categories/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253833', + 'abilityTreeNodes' => [ + 'FEATUREbdrcVNSW9V', + 'FEATUREbdrcTWEWJD', + 'FEATUREbdrcI7HVLO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标，如果有下一页，则该字段有返回值。说明 该参数只要返回数据，则说明还有下一页。您可以将返回的NextToken作为请求参数再次获得下一页的数据，直到返回为Null，表示获取到了所有的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'cae**********699', + ], + ], + [ + 'name' => 'ResourceCategoryId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'rc-123****7890', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ListResult<ResourceCategory>>', + 'description' => 'BaseResponse<ListResult<ResourceCategory>>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceCategoryId' => [ + 'title' => '资源分类id，全局唯一', + 'description' => '资源分类id，全局唯一', + 'type' => 'string', + 'example' => 'rc-123***7890', + ], + 'ResourceCategoryName' => [ + 'title' => '资源名，namespace内唯一', + 'description' => '资源名，namespace内唯一', + 'type' => 'string', + 'example' => 'My***ResourceCategory', + ], + 'ResourceCategoryType' => [ + 'title' => '资源分类类型 (DEFAULT: 默认分组，由系统创建，禁止删除, CUSTOM: 自定义分组，允许删除)', + 'description' => '资源分类类型 (DEFAULT: 默认分组，由系统创建，禁止删除, CUSTOM: 自定义分组，允许删除)', + 'type' => 'string', + 'example' => 'CUSTOM', + ], + 'ProductType' => [ + 'title' => '适用的产品类型，为空时匹配全部产品', + 'description' => '适用的产品类型，为空时匹配全部产品', + 'type' => 'string', + 'example' => 'ecs', + ], + 'ResourceType' => [ + 'title' => '适用的资源类型，为空时匹配全部资源', + 'description' => '适用的资源类型，为空时匹配全部资源', + 'type' => 'string', + 'example' => 'ACS::ECS::Instance', + ], + 'ResourceMatcher' => [ + 'title' => '资源匹配器，为空时不匹配任何资源', + 'description' => '资源匹配器，为空时不匹配任何资源', + 'type' => 'string', + 'example' => '{\\"type\\":\\"BOOL\\",\\"operator\\":\\"AND\\",\\"values\\":[{\\"type\\":\\"TAG\\",\\"key\\":\\"createdBy\\",\\"operator\\":\\"EQUAL\\",\\"values\\":[\\"me\\"]}]}', + ], + 'ResourceCount' => [ + 'title' => '各类型资源数量', + 'description' => '各类型资源数量', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ACS::ECS::Instance', + ], + 'Count' => [ + 'title' => '各类型资源数量', + 'description' => '各类型资源数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'example' => 'eKDyCM0zFQ5op7jVMWmNNA==', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => 'AE43C4CB-8074-5EBD-9806-8CA6D12800B1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"ResourceCategoryId\\": \\"rc-123***7890\\",\\n \\"ResourceCategoryName\\": \\"My***ResourceCategory\\",\\n \\"ResourceCategoryType\\": \\"CUSTOM\\",\\n \\"ProductType\\": \\"ecs\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"ResourceMatcher\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AND\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"values\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TAG\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"createdBy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EQUAL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"values\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"me\\\\\\\\\\\\\\"]}]}\\",\\n \\"ResourceCount\\": [\\n {\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"eKDyCM0zFQ5op7jVMWmNNA==\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 5\\n },\\n \\"RequestId\\": \\"AE43C4CB-8074-5EBD-9806-8CA6D12800B1\\"\\n}","type":"json"}]', + 'title' => '获取资源分类列表', + ], + 'GetResourceCategory' => [ + 'summary' => '获取单个资源分类。', + 'path' => '/api/v1/resource-categories/get', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253833', + 'abilityTreeNodes' => [ + 'FEATUREbdrcVNSW9V', + 'FEATUREbdrcTWEWJD', + 'FEATUREbdrcI7HVLO', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceCategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源分类ID', + 'type' => 'string', + 'required' => true, + 'example' => 'rc-123****7890', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ListResult<ResourceCategory>>', + 'description' => 'BaseResponse<ListResult<ResourceCategory>>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'ResourceCategoryId' => [ + 'title' => '资源分类id，全局唯一', + 'description' => '资源分类id，全局唯一', + 'type' => 'string', + 'example' => 'rc-123***7890', + ], + 'ResourceCategoryName' => [ + 'title' => '资源名，namespace内唯一', + 'description' => '资源名，namespace内唯一', + 'type' => 'string', + 'example' => 'My***ResourceCategory', + ], + 'ResourceCategoryType' => [ + 'title' => '资源分类类型 (DEFAULT: 默认分组，由系统创建，禁止删除, CUSTOM: 自定义分组，允许删除)', + 'description' => '资源分类类型 (DEFAULT: 默认分组，由系统创建，禁止删除, CUSTOM: 自定义分组，允许删除)', + 'type' => 'string', + 'example' => 'CUSTOM', + ], + 'ProductType' => [ + 'title' => '适用的产品类型，为空时匹配全部产品', + 'description' => '适用的产品类型，为空时匹配全部产品', + 'type' => 'string', + 'example' => 'ecs', + ], + 'ResourceType' => [ + 'title' => '适用的资源类型，为空时匹配全部资源', + 'description' => '适用的资源类型，为空时匹配全部资源', + 'type' => 'string', + 'example' => 'ACS::ECS::Instance', + ], + 'ResourceMatcher' => [ + 'title' => '资源匹配器，为空时不匹配任何资源', + 'description' => '资源匹配器，为空时不匹配任何资源', + 'type' => 'string', + 'example' => '{\\"type\\":\\"BOOL\\",\\"operator\\":\\"AND\\",\\"values\\":[{\\"type\\":\\"TAG\\",\\"key\\":\\"createdBy\\",\\"operator\\":\\"EQUAL\\",\\"values\\":[\\"me\\"]}]}', + ], + 'ResourceCount' => [ + 'title' => '各类型资源数量', + 'description' => '各类型资源数量', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ACS::ECS::Instance', + ], + 'Count' => [ + 'title' => '各类型资源数量', + 'description' => '各类型资源数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => 'AE43C4CB-8074-5EBD-9806-8CA6D12800B1', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ResourceCategoryId\\": \\"rc-123***7890\\",\\n \\"ResourceCategoryName\\": \\"My***ResourceCategory\\",\\n \\"ResourceCategoryType\\": \\"CUSTOM\\",\\n \\"ProductType\\": \\"ecs\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"ResourceMatcher\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AND\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"values\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TAG\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"createdBy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EQUAL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"values\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"me\\\\\\\\\\\\\\"]}]}\\",\\n \\"ResourceCount\\": [\\n {\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"Count\\": 1\\n }\\n ]\\n },\\n \\"RequestId\\": \\"AE43C4CB-8074-5EBD-9806-8CA6D12800B1\\"\\n}","type":"json"}]', + 'title' => '获取单个资源分类', + ], + 'CreateResourceCategory' => [ + 'summary' => '创建资源分类。', + 'path' => '/api/v1/resource-categories/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253834', + 'abilityTreeNodes' => [ + 'FEATUREbdrcVNSW9V', + 'FEATUREbdrcTWEWJD', + 'FEATUREbdrcI7HVLO', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ACS::ECS::Instance', + 'enum' => [ + 'ACS::ECS::Instance', + 'ACS::OSS::Bucket', + 'ACS::NAS::FileSystem', + 'ACS::OTS::Instance', + ], + ], + ], + [ + 'name' => 'ResourceCategoryName', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源分类名', + 'type' => 'string', + 'required' => true, + 'example' => 'My***ResourceCategory', + ], + ], + [ + 'name' => 'ResourceMatcher', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源匹配器', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "type": "BOOL",'."\n" + .' "operator": "AND",'."\n" + .' "values": ['."\n" + .' {'."\n" + .' "type": "TAG",'."\n" + .' "operator": "EQUAL",'."\n" + .' "key": "key0",'."\n" + .' "values": ['."\n" + .' "value0"'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "type": "TAG",'."\n" + .' "operator": "KEY_EXIST",'."\n" + .' "key": "key1"'."\n" + .' },'."\n" + .' {'."\n" + .' "type": "TAG",'."\n" + .' "operator": "KEY_EXIST_NOT_EQUAL",'."\n" + .' "key": "key2",'."\n" + .' "values": ['."\n" + .' "value2-wrong"'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<String>', + 'description' => 'BaseResponse<String>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'ResourceCategoryId' => [ + 'title' => '资源分类ID', + 'description' => '资源分类ID', + 'type' => 'string', + 'example' => 'rc-123****7890', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => 'AF95C627-D725-5656-B128-B9BCCAF89025', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ResourceCategoryId\\": \\"rc-123****7890\\"\\n },\\n \\"RequestId\\": \\"AF95C627-D725-5656-B128-B9BCCAF89025\\"\\n}","type":"json"}]', + 'title' => '创建资源分类', + ], + 'ListMessages' => [ + 'summary' => '批量查询消息。', + 'path' => '/api/v1/messages', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标，如果有下一页，则该字段有返回值。说明 该参数只要返回数据，则说明还有下一页。您可以将返回的NextToken作为请求参数再次获得下一页的数据，直到返回为Null，表示获取到了所有的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'cae***********99', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'MessageTimeLaterThan', + 'in' => 'query', + 'schema' => [ + 'description' => '消息时间晚于', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1740019609', + ], + ], + [ + 'name' => 'MessageTimeEarlierThan', + 'in' => 'query', + 'schema' => [ + 'description' => '消息时间早于', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1740019610', + ], + ], + [ + 'name' => 'MessageType', + 'in' => 'query', + 'schema' => [ + 'description' => '消息类型', + 'type' => 'string', + 'required' => false, + 'example' => 'SUB_PROTECTION_POLICY_MODIFIED', + ], + ], + [ + 'name' => 'MessageLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '消息等级', + 'type' => 'string', + 'required' => false, + 'example' => 'WARNING', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一标识', + 'description' => '请求唯一标识', + 'type' => 'string', + 'example' => '5748C531-80B1-5C31-8421-63A1830B9E48', + ], + 'Data' => [ + 'title' => '响应数据', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '响应内容', + 'description' => '响应内容', + 'type' => 'array', + 'items' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'title' => '消息ID', + 'description' => '消息ID', + 'type' => 'string', + 'example' => 'zgrjap8j-us04-owef-fpmo-kdpr80pbss0k', + ], + 'MessageName' => [ + 'title' => '消息名', + 'description' => '消息名', + 'type' => 'string', + 'example' => 'MyMessage', + ], + 'MessageTime' => [ + 'title' => '消息时间', + 'description' => '消息时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1740019609', + ], + 'MessageType' => [ + 'title' => '消息类型', + 'description' => '消息类型', + 'type' => 'string', + 'example' => 'SUB_PROTECTION_POLICY_MODIFIED', + ], + 'MessageLevel' => [ + 'title' => '消息等级', + 'description' => '消息等级', + 'type' => 'string', + 'example' => 'WARNING', + ], + 'MessageSourceType' => [ + 'title' => '消息源类型', + 'description' => '消息源类型', + 'type' => 'string', + 'example' => 'PROTECTION_POLICY', + ], + 'MessageSourceId' => [ + 'title' => '消息源ID', + 'description' => '消息源ID', + 'type' => 'string', + 'example' => 'p-123***7890', + ], + 'MessageSourceRegionId' => [ + 'title' => '消息源地域ID', + 'description' => '消息源地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '分页游标', + 'description' => '分页游标', + 'type' => 'string', + 'example' => 'eKDyCM0zFQ5op7jVMWmNNA==', + ], + 'MaxResults' => [ + 'title' => '请求的最大结果数', + 'description' => '请求的最大结果数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '结果总数', + 'description' => '结果总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5748C531-80B1-5C31-8421-63A1830B9E48\\",\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"MessageId\\": \\"zgrjap8j-us04-owef-fpmo-kdpr80pbss0k\\",\\n \\"MessageName\\": \\"MyMessage\\",\\n \\"MessageTime\\": 1740019609,\\n \\"MessageType\\": \\"SUB_PROTECTION_POLICY_MODIFIED\\",\\n \\"MessageLevel\\": \\"WARNING\\",\\n \\"MessageSourceType\\": \\"PROTECTION_POLICY\\",\\n \\"MessageSourceId\\": \\"p-123***7890\\",\\n \\"MessageSourceRegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"NextToken\\": \\"eKDyCM0zFQ5op7jVMWmNNA==\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 42\\n }\\n}","type":"json"}]', + 'title' => '批量查询消息', + ], + 'GetMessage' => [ + 'summary' => '获取单个消息。', + 'path' => '/api/v1/messages/{MessageId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'MessageId', + 'in' => 'path', + 'schema' => [ + 'description' => '消息ID', + 'type' => 'string', + 'required' => true, + 'example' => 'm-123****890', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '响应数据', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'title' => '消息ID', + 'description' => '消息ID', + 'type' => 'string', + 'example' => 'm-123***7890', + ], + 'MessageName' => [ + 'title' => '消息名', + 'description' => '消息名', + 'type' => 'string', + 'example' => 'MyMessage', + ], + 'MessageType' => [ + 'title' => '消息类型', + 'description' => '消息类型', + 'type' => 'string', + 'example' => 'SUB_PROTECTION_POLICY_MODIFIED', + ], + 'MessageTime' => [ + 'title' => '消息时间', + 'description' => '消息时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1740019609', + ], + 'MessageLevel' => [ + 'title' => '消息等级', + 'description' => '消息等级', + 'type' => 'string', + 'example' => 'WARNING', + ], + 'MessageSourceType' => [ + 'title' => '消息源类型', + 'description' => '消息源类型', + 'type' => 'string', + 'example' => 'PROTECTION_POLICY', + ], + 'MessageSourceId' => [ + 'title' => '消息源ID', + 'description' => '消息源ID', + 'type' => 'string', + 'example' => 'p-123***7890', + ], + 'MessageSourceRegionId' => [ + 'title' => '消息源地域ID', + 'description' => '消息源地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MessageContent' => [ + 'title' => '消息内容', + 'description' => '消息内容', + 'type' => 'string', + 'example' => '{********}', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '8724BC18-904D-5A0D-BFF4-F0554F0037E7', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"MessageId\\": \\"m-123***7890\\",\\n \\"MessageName\\": \\"MyMessage\\",\\n \\"MessageType\\": \\"SUB_PROTECTION_POLICY_MODIFIED\\",\\n \\"MessageTime\\": 1740019609,\\n \\"MessageLevel\\": \\"WARNING\\",\\n \\"MessageSourceType\\": \\"PROTECTION_POLICY\\",\\n \\"MessageSourceId\\": \\"p-123***7890\\",\\n \\"MessageSourceRegionId\\": \\"cn-hangzhou\\",\\n \\"MessageContent\\": \\"{********}\\"\\n },\\n \\"RequestId\\": \\"8724BC18-904D-5A0D-BFF4-F0554F0037E7\\"\\n}","type":"json"}]', + 'title' => '获取单个消息', + ], + 'ListProtectionPolicyApplications' => [ + 'summary' => '获取保护策略应用历史。', + 'path' => '/api/v1/protection-policies/{ProtectionPolicyId}/list-applications', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProtectionPolicyId', + 'in' => 'path', + 'schema' => [ + 'description' => '保护策略ID', + 'type' => 'string', + 'required' => true, + 'example' => 'p-123****890', + ], + ], + [ + 'name' => 'SubProtectionPolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '子保护策略类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_AUTO_SNAPSHOT_POLICY', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。您可以调用DescribeTasks查看任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't-0004d9ctt1ii********', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标，如果有下一页，则该字段有返回值。说明 该参数只要返回数据，则说明还有下一页。您可以将返回的NextToken作为请求参数再次获得下一页的数据，直到返回为Null，表示获取到了所有的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'cae**********699', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ACS::ECS::Instance', + ], + ], + [ + 'name' => 'ApplyStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '应用状态', + 'type' => 'string', + 'required' => false, + 'example' => 'FAILED', + 'enum' => [ + 'SKIPPED', + 'SUCCESS', + 'FAILED', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一标识', + 'description' => '请求唯一标识', + 'type' => 'string', + 'example' => '34081B20-C4C0-514F-93F6-8EEC3D1A587E', + ], + 'Data' => [ + 'title' => '响应数据', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '响应内容', + 'description' => '响应内容', + 'type' => 'array', + 'items' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'object', + 'properties' => [ + 'ProtectionPolicyId' => [ + 'title' => '保护策略ID', + 'description' => '保护策略ID', + 'type' => 'string', + 'example' => 'p-123***7890', + ], + 'ResourceArn' => [ + 'title' => '资源ARN', + 'description' => '资源ARN', + 'type' => 'string', + 'example' => 'acs:ecs:123***890:cn-shanghai:instance/i-001***90'."\n", + ], + 'ResourceId' => [ + 'title' => '资源ID', + 'description' => '资源ID', + 'type' => 'string', + 'example' => 'i-xxxxxxxx', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ACS::ECS::Instance', + ], + 'ProductType' => [ + 'title' => '产品类型', + 'description' => '产品类型', + 'type' => 'string', + 'example' => 'ecs', + ], + 'SubProtectionPolicyType' => [ + 'title' => '子保护策略类型', + 'description' => '子保护策略类型', + 'type' => 'string', + 'example' => 'ECS_AUTO_SNAPSHOT_POLICY', + ], + 'TaskId' => [ + 'title' => '任务ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => 't-0000e4w0u1v592zdf6s7', + ], + 'ApplyTime' => [ + 'title' => '应用策略的时间', + 'description' => '应用策略的时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2024-11-19T02:19:06Z', + ], + 'ApplyStatus' => [ + 'title' => '应用策略的状态', + 'description' => '应用策略的状态', + 'type' => 'string', + 'example' => 'FAILED', + ], + 'ApplyDetail' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '{"errorCode":"HbrPolicyNotFound","errorMessage":"po-123***7890"}', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '分页游标', + 'description' => '分页游标', + 'type' => 'string', + 'example' => 'fb836242f4225fa0f0e0257362dfc6dd', + ], + 'MaxResults' => [ + 'title' => '请求的最大结果数', + 'description' => '请求的最大结果数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '结果总数', + 'description' => '结果总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34081B20-C4C0-514F-93F6-8EEC3D1A587E\\",\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"ProtectionPolicyId\\": \\"p-123***7890\\",\\n \\"ResourceArn\\": \\"acs:ecs:123***890:cn-shanghai:instance/i-001***90\\\\n\\",\\n \\"ResourceId\\": \\"i-xxxxxxxx\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"ProductType\\": \\"ecs\\",\\n \\"SubProtectionPolicyType\\": \\"ECS_AUTO_SNAPSHOT_POLICY\\",\\n \\"TaskId\\": \\"t-0000e4w0u1v592zdf6s7\\",\\n \\"ApplyTime\\": 0,\\n \\"ApplyStatus\\": \\"FAILED\\",\\n \\"ApplyDetail\\": \\"{\\\\\\"errorCode\\\\\\":\\\\\\"HbrPolicyNotFound\\\\\\",\\\\\\"errorMessage\\\\\\":\\\\\\"po-123***7890\\\\\\"}\\"\\n }\\n ],\\n \\"NextToken\\": \\"fb836242f4225fa0f0e0257362dfc6dd\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 5\\n }\\n}","type":"json"}]', + 'title' => '获取保护策略应用历史', + ], + 'UpdateProtectionPolicy' => [ + 'summary' => '更新保护策略。', + 'path' => '/api/v1/protection-policies/{ProtectionPolicyId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => 'a1b2c3d4-****-****-****-a1b2c3d4f5e6', + ], + ], + [ + 'name' => 'ProtectionPolicyId', + 'in' => 'path', + 'schema' => [ + 'description' => '保护策略ID', + 'type' => 'string', + 'required' => true, + 'example' => 'p-123***7890', + ], + ], + [ + 'name' => 'ProtectionPolicyName', + 'in' => 'formData', + 'schema' => [ + 'description' => '保护策略名', + 'type' => 'string', + 'required' => false, + 'example' => 'My***Policy', + ], + ], + [ + 'name' => 'BoundResourceCategoryIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '关联的资源分类ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '关联的资源分类ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rc-123***7890', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SubProtectionPolicies', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '启用的子保护策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '子保护策略', + 'type' => 'object', + 'properties' => [ + 'SubProtectionPolicyType' => [ + 'description' => '子保护策略类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_AUTO_SNAPSHOT_POLICY', + ], + 'Config' => [ + 'description' => '子保护策略配置', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"autoSnapshotPolicyId\\":\\"sp-123***7890\\"}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9\\"\\n}","type":"json"}]', + 'title' => '更新保护策略', + ], + 'ListProtectionPolicies' => [ + 'summary' => '获取保护策略列表。', + 'path' => '/api/v1/protection-policies', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProtectionPolicyRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '保护策略地域ID', + 'description' => '保护策略地域ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '最大返回结果数', + 'description' => '最大返回结果数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '分页游标', + 'description' => '分页游标', + 'type' => 'string', + 'required' => false, + 'example' => 'cae**********699', + ], + ], + [ + 'name' => 'ProtectionPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '保护策略ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-123***7890', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一标识', + 'description' => '请求唯一标识', + 'type' => 'string', + 'example' => '5B2F09BF-CEBD-5A7E-AC01-E7F86169A5E5', + ], + 'Data' => [ + 'title' => '响应数据', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '响应内容', + 'description' => '响应内容', + 'type' => 'array', + 'items' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'object', + 'properties' => [ + 'ProtectionPolicyRegionId' => [ + 'title' => '保护策略地域ID', + 'description' => '保护策略地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ProtectionPolicyId' => [ + 'title' => '保护策略ID', + 'description' => '保护策略ID', + 'type' => 'string', + 'example' => 'p-123***7890', + ], + 'ProtectionPolicyName' => [ + 'title' => '保护策略名', + 'description' => '保护策略名', + 'type' => 'string', + 'example' => 'MyProtectionPolicy', + ], + 'BoundResourceCategoryIds' => [ + 'title' => '绑定的资源分类ID', + 'description' => '绑定的资源分类ID', + 'type' => 'array', + 'items' => [ + 'description' => '关联的资源分类ID列表', + 'type' => 'string', + 'example' => 'rc-123***7890', + ], + ], + 'SubProtectionPolicies' => [ + 'title' => '子保护策略', + 'description' => '子保护策略', + 'type' => 'array', + 'items' => [ + 'description' => '子保护策略', + 'type' => 'object', + 'properties' => [ + 'SubProtectionPolicyType' => [ + 'title' => '子保护策略类型', + 'description' => '子保护策略类型', + 'type' => 'string', + 'example' => 'ECS_AUTO_SNAPSHOT_POLICY', + ], + 'Config' => [ + 'title' => '子保护策略配置', + 'description' => '子保护策略配置', + 'type' => 'string', + 'example' => '{\\"autoSnapshotPolicyId\\":\\"sp-123***7890\\"}', + ], + ], + ], + ], + 'LatestApplyTime' => [ + 'title' => '最近一次应用时间', + 'description' => '最近一次应用时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1742167218', + ], + 'LatestTaskId' => [ + 'title' => '最近应用策略的任务ID', + 'description' => '最近应用策略的任务ID', + 'type' => 'string', + 'example' => 't-123***7890', + ], + 'LatestApplySummary' => [ + 'description' => '最近一次应用结果总结', + 'type' => 'object', + 'properties' => [ + 'CompleteTime' => [ + 'description' => '任务完成时间。Unix时间戳格式，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1742167218', + ], + 'ResourceCount' => [ + 'description' => '各类型资源数量', + 'type' => 'array', + 'items' => [ + 'description' => '各类型资源数量', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ACS::OTS::Instance', + ], + 'Count' => [ + 'description' => '各类型资源数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'ApplyStatusCount' => [ + 'description' => '应用状态统计计数', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApplyStatus' => [ + 'description' => '应用状态', + 'type' => 'string', + 'example' => 'FAILED', + ], + 'Count' => [ + 'description' => '各类型资源数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '分页游标', + 'description' => '分页游标', + 'type' => 'string', + 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAOTzWWYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3NTcwMzY2MjMwNzY2ODcyMzAzMTY2Nzg3ODY5MzY=', + ], + 'MaxResults' => [ + 'title' => '请求的最大结果数', + 'description' => '请求的最大结果数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '结果总数', + 'description' => '结果总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B2F09BF-CEBD-5A7E-AC01-E7F86169A5E5\\",\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"ProtectionPolicyRegionId\\": \\"cn-hangzhou\\",\\n \\"ProtectionPolicyId\\": \\"p-123***7890\\",\\n \\"ProtectionPolicyName\\": \\"MyProtectionPolicy\\",\\n \\"BoundResourceCategoryIds\\": [\\n \\"rc-123***7890\\"\\n ],\\n \\"SubProtectionPolicies\\": [\\n {\\n \\"SubProtectionPolicyType\\": \\"ECS_AUTO_SNAPSHOT_POLICY\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"autoSnapshotPolicyId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sp-123***7890\\\\\\\\\\\\\\"}\\"\\n }\\n ],\\n \\"LatestApplyTime\\": 1742167218,\\n \\"LatestTaskId\\": \\"t-123***7890\\",\\n \\"LatestApplySummary\\": {\\n \\"CompleteTime\\": 1742167218,\\n \\"ResourceCount\\": [\\n {\\n \\"ResourceType\\": \\"ACS::OTS::Instance\\",\\n \\"Count\\": 1\\n }\\n ],\\n \\"ApplyStatusCount\\": [\\n {\\n \\"ApplyStatus\\": \\"FAILED\\",\\n \\"Count\\": 3\\n }\\n ]\\n }\\n }\\n ],\\n \\"NextToken\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAOTzWWYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3NTcwMzY2MjMwNzY2ODcyMzAzMTY2Nzg3ODY5MzY=\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 5\\n }\\n}","type":"json"}]', + 'title' => '获取保护策略列表', + ], + 'GetProtectionPolicy' => [ + 'summary' => '获取保护策略。', + 'path' => '/api/v1/protection-policies/{ProtectionPolicyId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProtectionPolicyId', + 'in' => 'path', + 'schema' => [ + 'description' => '保护策略ID', + 'type' => 'string', + 'required' => true, + 'example' => 'p-123***7890', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '响应数据', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'ProtectionPolicyRegionId' => [ + 'description' => '保护策略地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ProtectionPolicyId' => [ + 'description' => '保护策略ID', + 'type' => 'string', + 'example' => 'p-123***7890', + ], + 'ProtectionPolicyName' => [ + 'description' => '保护策略名', + 'type' => 'string', + 'example' => 'MyProtectionPolicy', + ], + 'BoundResourceCategoryIds' => [ + 'description' => '关联的资源分类ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源分类ID', + 'type' => 'string', + 'example' => 'rc-123***7890', + ], + ], + 'SubProtectionPolicies' => [ + 'description' => '配置的子保护策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '启用的子保护策略列表', + 'type' => 'object', + 'properties' => [ + 'SubProtectionPolicyType' => [ + 'description' => '子保护策略类型', + 'type' => 'string', + 'example' => 'ECS_AUTO_SNAPSHOT_POLICY', + ], + 'Config' => [ + 'description' => '子保护策略配置', + 'type' => 'string', + 'example' => '{\\"autoSnapshotPolicyId\\":\\"sp-123***7890\\"}', + ], + ], + ], + ], + 'LatestApplyTime' => [ + 'description' => '最近一次应用时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1742167218', + ], + 'LatestTaskId' => [ + 'title' => '', + 'description' => '最近一次应用任务ID', + 'type' => 'string', + 'example' => 't-123***7890', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => 'AE43C4CB-8074-5EBD-9806-8CA6D12800B1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ProtectionPolicyRegionId\\": \\"cn-hangzhou\\",\\n \\"ProtectionPolicyId\\": \\"p-123***7890\\",\\n \\"ProtectionPolicyName\\": \\"MyProtectionPolicy\\",\\n \\"BoundResourceCategoryIds\\": [\\n \\"rc-123***7890\\"\\n ],\\n \\"SubProtectionPolicies\\": [\\n {\\n \\"SubProtectionPolicyType\\": \\"ECS_AUTO_SNAPSHOT_POLICY\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"autoSnapshotPolicyId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sp-123***7890\\\\\\\\\\\\\\"}\\"\\n }\\n ],\\n \\"LatestApplyTime\\": 1742167218,\\n \\"LatestTaskId\\": \\"t-123***7890\\"\\n },\\n \\"RequestId\\": \\"AE43C4CB-8074-5EBD-9806-8CA6D12800B1\\"\\n}","type":"json"}]', + 'title' => '获取保护策略', + ], + 'DeleteProtectionPolicy' => [ + 'summary' => '删除保护策略。', + 'path' => '/api/v1/protection-policies/{ProtectionPolicyId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProtectionPolicyId', + 'in' => 'path', + 'schema' => [ + 'description' => '保护策略ID', + 'type' => 'string', + 'required' => true, + 'example' => 'p-123***7890', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '5B2F09BF-CEBD-5A7E-AC01-E7F86169A5E5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B2F09BF-CEBD-5A7E-AC01-E7F86169A5E5\\"\\n}","type":"json"}]', + 'title' => '删除保护策略', + ], + 'CreateProtectionPolicy' => [ + 'summary' => '创建保护策略。', + 'path' => '/api/v1/protection-policies', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => 'a1b2c3d4-****-****-****-a1b2c3d4f5e6', + ], + ], + [ + 'name' => 'ProtectionPolicyRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '保护策略地域ID', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProtectionPolicyName', + 'in' => 'formData', + 'schema' => [ + 'description' => '保护策略名', + 'type' => 'string', + 'required' => true, + 'example' => 'My***Policy', + ], + ], + [ + 'name' => 'BoundResourceCategoryIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '关联的资源分类ID', + 'type' => 'array', + 'items' => [ + 'description' => '关联的资源分类ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rc-123**7890', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SubProtectionPolicies', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '子保护策略', + 'type' => 'array', + 'items' => [ + 'description' => '子保护策略', + 'type' => 'object', + 'properties' => [ + 'SubProtectionPolicyType' => [ + 'description' => '子保护策略类型', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS_AUTO_SNAPSHOT_POLICY', + ], + 'Config' => [ + 'description' => '子保护策略配置', + 'type' => 'string', + 'required' => false, + 'example' => '{\'PlaybookUuid\': \'2093d1ea-0651-48a6-bea2-fa7157285dc1\', \'ParamType\': \'custom\', \'InputParams\': \'\'}', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '响应数据', + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'ProtectionPolicyId' => [ + 'title' => '保护策略ID', + 'description' => '保护策略ID', + 'type' => 'string', + 'example' => 'p-123***7890', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '34081B20-C4C0-514F-93F6-8EEC3D1A587E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ProtectionPolicyId\\": \\"p-123***7890\\"\\n },\\n \\"RequestId\\": \\"34081B20-C4C0-514F-93F6-8EEC3D1A587E\\"\\n}","type":"json"}]', + 'title' => '创建保护策略', + ], + 'UpdateResources' => [ + 'path' => '/api/v1/resources/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '195928', + 'abilityTreeNodes' => [ + 'FEATUREbdrcVNSW9V', + 'FEATUREbdrcTWEWJD', + 'FEATUREbdrcI7HVLO', + 'FEATUREbdrc2PRSPG', + 'FEATUREbdrcKTIN7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源类型，不填代表更新所有类型', + 'description' => '资源类型，不填代表更新所有类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ACS::ECS::Instance', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<AsyncResponseData>', + 'description' => 'BaseResponse<AsyncResponseData>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '异步任务的唯一标识', + 'description' => '异步任务的唯一标识', + 'type' => 'string', + 'example' => 't-bp1ewftyzmeg3bl4dtd2', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '5B2F09BF-CEBD-5A7E-AC01-E7F86169A5E5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'BDRC::2023-08-08::DescribeTask', + 'callbackInterval' => 5000, + 'maxCallbackTimes' => 100, + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TaskId\\": \\"t-bp1ewftyzmeg3bl4dtd2\\"\\n },\\n \\"RequestId\\": \\"5B2F09BF-CEBD-5A7E-AC01-E7F86169A5E5\\"\\n}","type":"json"}]', + 'title' => '更新资源列表', + 'summary' => '更新资源列表。调用该接口后，将会触发一个异步任务来更新您的资源列表和数据保护评分。', + ], + 'EnableCheckResource' => [ + 'path' => '/api/v1/resources/enable-check', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '195933', + 'abilityTreeNodes' => [ + 'FEATUREbdrcVNSW9V', + 'FEATUREbdrcTWEWJD', + 'FEATUREbdrcI7HVLO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceArn', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源唯一标识', + 'description' => '资源唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ecs:123***890:cn-shanghai:instance/i-001***90', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => 'E583A0FF-803C-51C4-9AC9-E029471ACD6A', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E583A0FF-803C-51C4-9AC9-E029471ACD6A\\"\\n}","type":"json"}]', + 'title' => '开启资源的数据保护评分', + 'summary' => '开启单个资源的数据保护评分。', + ], + 'EnableCheckProduct' => [ + 'path' => '/api/v1/products/enable-check', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '195925', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'formData', + 'schema' => [ + 'title' => '产品类型', + 'description' => '产品类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + 'enum' => [ + 'ecs', + 'oss', + 'nas', + 'ots', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识。', + 'type' => 'string', + 'example' => '8724BC18-904D-5A0D-BFF4-F0554F0037E7', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8724BC18-904D-5A0D-BFF4-F0554F0037E7\\"\\n}","type":"json"}]', + 'title' => '开启云产品的数据保护评分', + 'summary' => '开启云产品数据保护评分。', + ], + 'DisableCheckResource' => [ + 'path' => '/api/v1/resources/disable-check', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '195927', + 'abilityTreeNodes' => [ + 'FEATUREbdrcBCZW0W', + 'FEATUREbdrc39O5NC', + 'FEATUREbdrcL4UGPA', + 'FEATUREbdrc0N9DE2', + 'FEATUREbdrcDIQ7FY', + 'FEATUREbdrcUOO3SY', + 'FEATUREbdrcT2SYGM', + 'FEATUREbdrcG2LT8R', + 'FEATUREbdrc5P9BJ1', + 'FEATUREbdrc5DYMIO', + 'FEATUREbdrcF8LFI8', + 'FEATUREbdrcORA84U', + 'FEATUREbdrcPV3DO0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceArn', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源唯一标识', + 'description' => '资源唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ecs:123***890:cn-shanghai:instance/i-001***90', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9\\"\\n}","type":"json"}]', + 'title' => '关闭资源的数据保护评分', + 'summary' => '关闭资源的数据保护评分。', + ], + 'DisableCheckProduct' => [ + 'path' => '/api/v1/products/disable-check', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '195924', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'formData', + 'schema' => [ + 'title' => '产品类型', + 'description' => '产品类型', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + 'enum' => [ + 'ecs', + 'oss', + 'nas', + 'ots', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '89E3CBB7-16F3-52AE-BD32-31A43A2A807F', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89E3CBB7-16F3-52AE-BD32-31A43A2A807F\\"\\n}","type":"json"}]', + 'title' => '关闭云产品的数据保护评分', + 'summary' => '关闭云产品的数据保护评分。', + ], + 'CheckRules' => [ + 'path' => '/api/v1/rules/check', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '195932', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceArn', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源唯一标识', + 'description' => '资源唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ecs:123***890:cn-shanghai:instance/i-001***90', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'formData', + 'schema' => [ + 'title' => '需要更新的规则id，不填代表更新所有', + 'description' => '需要更新的规则id，不填代表更新所有。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule-000***dav', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<AsyncResponseData>', + 'description' => 'BaseResponse<AsyncResponseData>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '异步任务的唯一标识', + 'description' => '异步任务的唯一标识。', + 'type' => 'string', + 'example' => 't-0000e4w0u1v592zdf6s7', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识。', + 'type' => 'string', + 'example' => '700683DE-0154-56D4-8D76-3B7A2C2C7DF9', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'BDRC::2023-08-08::DescribeTask', + 'callbackInterval' => 5000, + 'maxCallbackTimes' => 100, + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TaskId\\": \\"t-0000e4w0u1v592zdf6s7\\"\\n },\\n \\"RequestId\\": \\"700683DE-0154-56D4-8D76-3B7A2C2C7DF9\\"\\n}","type":"json"}]', + 'title' => '检查数据保护评分规则', + 'summary' => '检查数据保护评分规则，调用该接口将会触发一个异步任务来检查您的资源是否满足数据保护评分的要求。', + ], + 'DescribeRules' => [ + 'summary' => '查询数据保护规则列表。', + 'path' => '/api/v1/rules', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195920', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ACS::ECS::Instance', + 'enum' => [ + 'ACS::ECS::Instance', + 'ACS::OSS::Bucket', + 'ACS::NAS::FileSystem', + 'ACS::OTS::Instance', + ], + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。 如果NextToken有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'cae**********699', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的最大条目数。最大值为50。默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ResourceCategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源分类ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rc-000***123', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所在地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ListResult<Rule>>', + 'description' => 'BaseResponse<ListResult<Rule>>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'title' => '规则的唯一标识', + 'description' => '规则的唯一标识', + 'type' => 'string', + 'example' => 'rule-bp11ggd8wr762', + ], + 'ProductType' => [ + 'title' => '适用的产品类型', + 'description' => '适用的产品类型', + 'type' => 'string', + 'example' => 'ecs', + ], + 'ResourceType' => [ + 'title' => '适用的资源类型', + 'description' => '适用的资源类型', + 'type' => 'string', + 'example' => 'ACS::ECS::Instance', + ], + 'RuleTemplate' => [ + 'title' => '规则模板', + 'description' => '规则模板', + 'type' => 'string', + 'example' => 'ecs-backup', + ], + 'CheckStatus' => [ + 'title' => '检查状态 (NOT_CHECKED: 未检查, PASSED: 检查通过, FAILED: 检查未通过, CHECKING: 检查中, CHECK_FAILED: 检查失败)', + 'description' => '检查状态 (NOT_CHECKED: 未检查, PASSED: 检查通过, FAILED: 检查未通过, CHECKING: 检查中, CHECK_FAILED: 检查失败)', + 'type' => 'string', + 'example' => 'PASSED', + ], + 'CheckTime' => [ + 'title' => '检查时间', + 'description' => '检查时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704157635', + ], + 'TotalResourceCount' => [ + 'title' => '检查的总资源数', + 'description' => '检查的总资源数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RiskyResourceCount' => [ + 'title' => '有风险的资源数', + 'description' => '有风险的资源数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CheckFailedResourceCount' => [ + 'title' => '检查失败的资源数', + 'description' => '检查失败的资源数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'example' => '0975951c75d7b41464c8d08ae17043ca', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"RuleId\\": \\"rule-bp11ggd8wr762\\",\\n \\"ProductType\\": \\"ecs\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"RuleTemplate\\": \\"ecs-backup\\",\\n \\"CheckStatus\\": \\"PASSED\\",\\n \\"CheckTime\\": 1704157635,\\n \\"TotalResourceCount\\": 1,\\n \\"RiskyResourceCount\\": 0,\\n \\"CheckFailedResourceCount\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"0975951c75d7b41464c8d08ae17043ca\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 42\\n },\\n \\"RequestId\\": \\"86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9\\"\\n}","type":"json"}]', + 'title' => '查询数据保护评分规则列表', + ], + 'DescribeCheckDetails' => [ + 'path' => '/api/v1/check-details', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '195929', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceArn', + 'in' => 'query', + 'schema' => [ + 'description' => '资源唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ecs:123***890:cn-shanghai:instance/i-001***90', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据保护规则唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'rule-000***dav', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。有关本接口查看返回数据的设置方式，请参见上文接口说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'cae**********699', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的最大条目数。默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ListResult<CheckDetail>>', + 'description' => 'BaseResponse<ListResult<CheckDetail>>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceArn' => [ + 'title' => '资源ARN(全局唯一)', + 'description' => '资源ARN(全局唯一)', + 'type' => 'string', + 'example' => 'acs:ecs:123***890:cn-shanghai:instance/i-001***90'."\n", + ], + 'RuleId' => [ + 'title' => '规则的唯一标识', + 'description' => '规则的唯一标识', + 'type' => 'string', + 'example' => 'rule-xxxxxxxx', + ], + 'ProductType' => [ + 'title' => '云产品类型', + 'description' => '云产品类型', + 'type' => 'string', + 'example' => 'ecs', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ACS::ECS::Instance', + ], + 'ResourceId' => [ + 'title' => '资源唯一标识', + 'description' => '资源唯一标识', + 'type' => 'string', + 'example' => 'i-xxxxxxxx', + ], + 'ResourceName' => [ + 'title' => '资源名称', + 'description' => '资源名称', + 'type' => 'string', + 'example' => 'test server', + ], + 'RuleTemplate' => [ + 'title' => '规则模板', + 'description' => '规则模板', + 'type' => 'string', + 'example' => 'ecs-backup', + ], + 'CheckStatus' => [ + 'title' => '检查状态 (NOT_CHECKED: 未检查, PASSED: 检查通过, FAILED: 检查未通过, CHECKING: 检查中, CHECK_FAILED: 检查失败)', + 'description' => '检查状态 (NOT_CHECKED: 未检查, PASSED: 检查通过, FAILED: 检查未通过, CHECKING: 检查中, CHECK_FAILED: 检查失败)', + 'type' => 'string', + 'example' => 'PASSED', + ], + 'CheckTime' => [ + 'title' => '检查时间', + 'description' => '检查时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1701725715', + ], + 'Detail' => [ + 'title' => '检查详情', + 'description' => '检查详情', + 'type' => 'string', + 'example' => '{"ecsAutoSnapshotPolicyIds":[],"hbrBackupPlans":[{"planId":"po-xxxxxxxx","sourceType":"UDM_ECS"}]}', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAOTzWWYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3NTcwMzY2MjMwNzY2ODcyMzAzMTY2Nzg3ODY5MzY=', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '92793A50-0B97-59F1-BAEA-EAED83BA1998', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"ResourceArn\\": \\"acs:ecs:123***890:cn-shanghai:instance/i-001***90\\\\n\\",\\n \\"RuleId\\": \\"rule-xxxxxxxx\\",\\n \\"ProductType\\": \\"ecs\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"ResourceId\\": \\"i-xxxxxxxx\\",\\n \\"ResourceName\\": \\"test server\\",\\n \\"RuleTemplate\\": \\"ecs-backup\\",\\n \\"CheckStatus\\": \\"PASSED\\",\\n \\"CheckTime\\": 1701725715,\\n \\"Detail\\": \\"{\\\\\\"ecsAutoSnapshotPolicyIds\\\\\\":[],\\\\\\"hbrBackupPlans\\\\\\":[{\\\\\\"planId\\\\\\":\\\\\\"po-xxxxxxxx\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"UDM_ECS\\\\\\"}]}\\"\\n }\\n ],\\n \\"NextToken\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAOTzWWYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3NTcwMzY2MjMwNzY2ODcyMzAzMTY2Nzg3ODY5MzY=\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"92793A50-0B97-59F1-BAEA-EAED83BA1998\\"\\n}","type":"json"}]', + 'title' => '查询数据保护规则检查结果', + 'summary' => '查询数据保护规则检查结果。', + ], + 'DescribeResources' => [ + 'summary' => '查询资源列表。', + 'path' => '/api/v1/resources', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195921', + 'abilityTreeNodes' => [ + 'FEATUREbdrcVNSW9V', + 'FEATUREbdrcTWEWJD', + 'FEATUREbdrcI7HVLO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ACS::ECS::Instance', + 'enum' => [ + 'ACS::ECS::Instance', + 'ACS::OSS::Bucket', + 'ACS::NAS::FileSystem', + 'ACS::OTS::Instance', + ], + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。例如，当待查询的资源为实例时，可以理解为InstanceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-0003***110', + ], + ], + [ + 'name' => 'FailedRuleTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '评分失败的规则过滤', + 'type' => 'string', + 'required' => false, + 'example' => 'rule-000c***yc9', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标，如果有下一页，则该字段有返回值。说明 该参数只要返回数据，则说明还有下一页。您可以将返回的NextToken作为请求参数再次获得下一页的数据，直到返回为Null，表示获取到了所有的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'cae**********699', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。最大值为100。默认值：当不设置值或设置的值小于10时，默认值为10。当设置的值大于100时，默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式', + 'type' => 'string', + 'required' => false, + 'example' => 'protectionScore', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'title' => 'ASC: 升序, DESC: 降序', + 'description' => 'ASC: 升序, DESC: 降序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '升序', + 'DESC' => '降序', + ], + 'example' => 'ASC', + 'enum' => [ + 'ASC', + 'DESC', + ], + ], + ], + [ + 'name' => 'StorageClass', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'ARCHIVE', + 'enum' => [ + 'STANDARD', + 'ARCHIVE', + 'IA', + 'COLD_ARCHIVE', + ], + ], + ], + [ + 'name' => 'DataRedundancyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'LRS', + 'enum' => [ + 'LRS', + 'ZRS', + ], + ], + ], + [ + 'name' => 'ResourceCategoryId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'rc-000***123', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceArn', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ecs:cn-hangzhou:123***7890:instance/i-123***7890', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ListResult<Resource>>', + 'description' => 'BaseResponse<ListResult<Resource>>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceArn' => [ + 'title' => '资源ARN(全局唯一)', + 'description' => '资源ARN(全局唯一)', + 'type' => 'string', + 'example' => 'acs:ecs:cn-hangzhou:xxxxxxxx:instance/xxxxx'."\n", + ], + 'ProductType' => [ + 'title' => '云产品类型', + 'description' => '云产品类型', + 'type' => 'string', + 'example' => 'ecs', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ACS::ECS::Instance'."\n", + ], + 'ResourceId' => [ + 'title' => '资源唯一标识', + 'description' => '资源唯一标识', + 'type' => 'string', + 'example' => 'i-xxxxxxxx'."\n", + ], + 'ResourceName' => [ + 'title' => '资源名称', + 'description' => '资源名称', + 'type' => 'string', + 'example' => 'test server', + ], + 'RegionId' => [ + 'title' => '地域', + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'title' => '可用区', + 'description' => '可用区', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'VpcId' => [ + 'title' => 'vpc ID', + 'description' => 'vpc ID', + 'type' => 'string', + 'example' => 'vpc-xxxxxxxx', + ], + 'VSwitchId' => [ + 'title' => 'vSwitch ID', + 'description' => 'vSwitch ID', + 'type' => 'string', + 'example' => 'vsw-xxxxxxxx', + ], + 'CreateTime' => [ + 'title' => '资源的创建时间', + 'description' => '资源的创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1697798340', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'Running', + ], + 'TotalDataSize' => [ + 'title' => '数据量', + 'description' => '数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'StandardDataSize' => [ + 'title' => '标准类型数据量', + 'description' => '标准类型数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IaDataSize' => [ + 'title' => '低频类型数据量', + 'description' => '低频类型数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ArchiveDataSize' => [ + 'title' => '归档类型数据量', + 'description' => '归档类型数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ColdArchiveDataSize' => [ + 'title' => '冷归档类型数据量', + 'description' => '冷归档类型数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'EnableCheck' => [ + 'title' => '是否开启数据保护评分评估', + 'description' => '是否开启数据保护评分评估', + 'type' => 'boolean', + 'example' => '0', + ], + 'ProtectionScore' => [ + 'title' => '资源保护评分', + 'description' => '资源保护评分', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProtectionScoreUpdatedTime' => [ + 'title' => '评分时间', + 'description' => '评分时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RiskCount' => [ + 'title' => '有风险的检查项目数', + 'description' => '有风险的检查项目数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CheckFailedCount' => [ + 'title' => '失败的检查项个数', + 'description' => '失败的检查项个数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'StorageClass' => [ + 'title' => '数据存储类型', + 'description' => '数据存储类型', + 'type' => 'string', + ], + 'DataRedundancyType' => [ + 'title' => '数据冗余类型', + 'description' => '数据冗余类型', + 'type' => 'string', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'example' => 'fb836242f4225fa0f0e0257362dfc6dd', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalCount' => [ + 'title' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '149', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '700683DE-0154-56D4-8D76-3B7A2C2C7DF9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"ResourceArn\\": \\"acs:ecs:cn-hangzhou:xxxxxxxx:instance/xxxxx\\\\n\\",\\n \\"ProductType\\": \\"ecs\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\\\n\\",\\n \\"ResourceId\\": \\"i-xxxxxxxx\\\\n\\",\\n \\"ResourceName\\": \\"test server\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"VpcId\\": \\"vpc-xxxxxxxx\\",\\n \\"VSwitchId\\": \\"vsw-xxxxxxxx\\",\\n \\"CreateTime\\": 1697798340,\\n \\"Status\\": \\"Running\\",\\n \\"TotalDataSize\\": 0,\\n \\"StandardDataSize\\": 0,\\n \\"IaDataSize\\": 0,\\n \\"ArchiveDataSize\\": 0,\\n \\"ColdArchiveDataSize\\": 0,\\n \\"EnableCheck\\": true,\\n \\"ProtectionScore\\": 0,\\n \\"ProtectionScoreUpdatedTime\\": 0,\\n \\"RiskCount\\": 0,\\n \\"CheckFailedCount\\": 0,\\n \\"StorageClass\\": \\"\\",\\n \\"DataRedundancyType\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"fb836242f4225fa0f0e0257362dfc6dd\\",\\n \\"MaxResults\\": 100,\\n \\"TotalCount\\": 149\\n },\\n \\"RequestId\\": \\"700683DE-0154-56D4-8D76-3B7A2C2C7DF9\\"\\n}","type":"json"}]', + 'title' => '查询资源列表', + ], + 'DescribeProducts' => [ + 'summary' => '查询云产品的数据保护评分状态。', + 'path' => '/api/v1/products', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195931', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceCategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源分类ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rc-000***123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ListResult<Product>>', + 'description' => 'BaseResponse<ListResult<Product>>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductType' => [ + 'title' => '云产品类型', + 'description' => '云产品类型，如ecs，oss等', + 'type' => 'string', + 'example' => 'oss', + ], + 'EnableCheck' => [ + 'title' => '是否开启数据保护评分评估', + 'description' => '是否开启数据保护评分评估', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProtectionScore' => [ + 'title' => '资源保护评分', + 'description' => '数据保护评分（0 - 100分）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'ProtectionScoreUpdatedTime' => [ + 'title' => '评分时间', + 'description' => '数据保护评分更新时间（UNIX时间）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1726036498', + ], + 'TotalResourceCount' => [ + 'title' => '资源总数', + 'description' => '资源总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RiskyResourceCount' => [ + 'title' => '有风险的资源数', + 'description' => '有风险的资源数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CheckFailedResourceCount' => [ + 'title' => '检查失败的资源数', + 'description' => '检查失败的资源数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DisableCheckResourceCount' => [ + 'title' => '关闭检查的资源数', + 'description' => '关闭检查的资源数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'WaitForCheckResourceCount' => [ + 'title' => '待检查的资源数', + 'description' => '待检查的资源数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RiskCount' => [ + 'title' => '有风险的检查项目数', + 'description' => '有风险的检查项目数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CheckFailedCount' => [ + 'title' => '失败的检查项个数', + 'description' => '失败的检查项个数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ProtectionScoreDistribution' => [ + 'title' => '不同分数段资源个数分布', + 'description' => '不同分数段资源个数分布', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Range' => [ + 'title' => '区间', + 'description' => '区间', + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'title' => '下限（包含边界）', + 'description' => '下限（包含边界）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'To' => [ + 'title' => '上限（包含边界）', + 'description' => '上限（包含边界）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + ], + ], + 'Count' => [ + 'title' => '区间内的个数', + 'description' => '区间内的个数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'example' => 'b4fd3cffcacafd65e3818a0b9b2ff9a2', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '30FB202A-1D22-5394-AB02-4477CDFCF51F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"ProductType\\": \\"oss\\",\\n \\"EnableCheck\\": true,\\n \\"ProtectionScore\\": 90,\\n \\"ProtectionScoreUpdatedTime\\": 1726036498,\\n \\"TotalResourceCount\\": 100,\\n \\"RiskyResourceCount\\": 1,\\n \\"CheckFailedResourceCount\\": 1,\\n \\"DisableCheckResourceCount\\": 1,\\n \\"WaitForCheckResourceCount\\": 1,\\n \\"RiskCount\\": 1,\\n \\"CheckFailedCount\\": 1,\\n \\"ProtectionScoreDistribution\\": [\\n {\\n \\"Range\\": {\\n \\"From\\": 0,\\n \\"To\\": 60\\n },\\n \\"Count\\": 5\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"b4fd3cffcacafd65e3818a0b9b2ff9a2\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 50\\n },\\n \\"RequestId\\": \\"30FB202A-1D22-5394-AB02-4477CDFCF51F\\"\\n}","type":"json"}]', + 'title' => '查询云产品保护评分', + ], + 'DescribeTopRiskyResources' => [ + 'summary' => '查询风险最多的资源列表。', + 'path' => '/api/v1/resources/top-risky', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199311', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ACS::ECS::Instance', + 'enum' => [ + 'ACS::ECS::Instance', + 'ACS::OSS::Bucket', + 'ACS::NAS::FileSystem', + 'ACS::OTS::Instance', + ], + ], + ], + [ + 'name' => 'ResourceCategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源分类ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rc-000***123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ListResult<Resource>>', + 'description' => 'BaseResponse<ListResult<Resource>>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceArn' => [ + 'title' => '资源ARN(全局唯一)', + 'description' => '资源ARN(全局唯一)', + 'type' => 'string', + 'example' => 'acs:ecs:cn-hangzhou:xxxxxxxx:instance/xxxxx', + ], + 'ProductType' => [ + 'title' => '云产品类型', + 'description' => '云产品类型', + 'type' => 'string', + 'example' => 'ecs', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ACS::ECS::Instance', + ], + 'ResourceId' => [ + 'title' => '资源唯一标识', + 'description' => '资源唯一标识', + 'type' => 'string', + 'example' => 'i-xxxxxxxx', + ], + 'ResourceName' => [ + 'title' => '资源名称', + 'description' => '资源名称', + 'type' => 'string', + 'example' => 'test-server', + ], + 'RegionId' => [ + 'title' => '地域', + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'title' => '可用区', + 'description' => '可用区', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'VpcId' => [ + 'title' => 'vpc ID', + 'description' => 'vpc ID', + 'type' => 'string', + 'example' => 'vpc-xxxxxxxx', + ], + 'VSwitchId' => [ + 'title' => 'vSwitch ID', + 'description' => 'vSwitch ID', + 'type' => 'string', + 'example' => 'vsw-xxxxxxxx', + ], + 'CreateTime' => [ + 'title' => '资源的创建时间', + 'description' => '资源的创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1697798340', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'Running', + ], + 'TotalDataSize' => [ + 'title' => '数据量', + 'description' => '数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'StandardDataSize' => [ + 'title' => '标准类型数据量', + 'description' => '标准类型数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IaDataSize' => [ + 'title' => '低频类型数据量', + 'description' => '低频类型数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ArchiveDataSize' => [ + 'title' => '归档类型数据量', + 'description' => '归档类型数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ColdArchiveDataSize' => [ + 'title' => '冷归档类型数据量', + 'description' => '冷归档类型数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'EnableCheck' => [ + 'title' => '是否开启数据保护评分评估', + 'description' => '是否开启数据保护评分评估', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProtectionScore' => [ + 'title' => '资源保护评分', + 'description' => '资源保护评分', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'ProtectionScoreUpdatedTime' => [ + 'title' => '评分时间', + 'description' => '评分时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1726036498', + ], + 'RiskCount' => [ + 'title' => '有风险的检查项目数', + 'description' => '有风险的检查项目数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CheckFailedCount' => [ + 'title' => '失败的检查项个数', + 'description' => '失败的检查项个数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'StorageClass' => [ + 'title' => '数据存储类型', + 'description' => '数据存储类型', + 'type' => 'string', + 'example' => 'STANDARD', + ], + 'DataRedundancyType' => [ + 'title' => '数据冗余类型', + 'description' => '数据冗余类型', + 'type' => 'string', + 'example' => 'LRS', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'example' => 'e557bc9a65fe22cb5e2a3b240f06b0de', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '34081B20-C4C0-514F-93F6-8EEC3D1A587E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"ResourceArn\\": \\"acs:ecs:cn-hangzhou:xxxxxxxx:instance/xxxxx\\",\\n \\"ProductType\\": \\"ecs\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"ResourceId\\": \\"i-xxxxxxxx\\",\\n \\"ResourceName\\": \\"test-server\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"VpcId\\": \\"vpc-xxxxxxxx\\",\\n \\"VSwitchId\\": \\"vsw-xxxxxxxx\\",\\n \\"CreateTime\\": 1697798340,\\n \\"Status\\": \\"Running\\",\\n \\"TotalDataSize\\": 0,\\n \\"StandardDataSize\\": 0,\\n \\"IaDataSize\\": 0,\\n \\"ArchiveDataSize\\": 0,\\n \\"ColdArchiveDataSize\\": 0,\\n \\"EnableCheck\\": true,\\n \\"ProtectionScore\\": 90,\\n \\"ProtectionScoreUpdatedTime\\": 1726036498,\\n \\"RiskCount\\": 0,\\n \\"CheckFailedCount\\": 0,\\n \\"StorageClass\\": \\"STANDARD\\",\\n \\"DataRedundancyType\\": \\"LRS\\"\\n }\\n ],\\n \\"NextToken\\": \\"e557bc9a65fe22cb5e2a3b240f06b0de\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"RequestId\\": \\"34081B20-C4C0-514F-93F6-8EEC3D1A587E\\"\\n}","type":"json"}]', + 'title' => '查询风险最高的资源列表', + ], + 'DescribeProductDataRedundancyTypeStat' => [ + 'summary' => '查询云产品数据冗余类型统计信息。', + 'path' => '/api/v1/products/data-redundancy-type-stat', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248277', + 'abilityTreeNodes' => [ + 'FEATUREbdrcIYL3Z9', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'title' => '云产品类型', + 'description' => '云产品类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss', + 'enum' => [], + ], + ], + [ + 'name' => 'ResourceCategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源分类ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rc-000***123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<List<DataRedundancyTypeStat>>', + 'description' => 'BaseResponse<List<DataRedundancyTypeStat>>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '本次请求所返回的记录集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StorageClass' => [ + 'title' => '数据存储类型', + 'description' => '数据存储类型。', + 'type' => 'string', + 'example' => 'STANDARD', + ], + 'DataRedundancyType' => [ + 'title' => '数据冗余类型', + 'description' => '数据冗余类型。', + 'type' => 'string', + 'example' => 'LRS', + ], + 'ResourceCount' => [ + 'title' => '资源数', + 'description' => '资源数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识。', + 'type' => 'string', + 'example' => '5748C531-80B1-5C31-8421-63A1830B9E48', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"StorageClass\\": \\"STANDARD\\",\\n \\"DataRedundancyType\\": \\"LRS\\",\\n \\"ResourceCount\\": 1\\n }\\n ]\\n },\\n \\"RequestId\\": \\"5748C531-80B1-5C31-8421-63A1830B9E48\\"\\n}","type":"json"}]', + 'title' => '查询数据冗余类型统计信息', + ], + 'DescribeTasks' => [ + 'path' => '/api/v1/tasks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197097', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskStatus', + 'in' => 'query', + 'schema' => [ + 'title' => 'CREATED: 创建, RUNNING: 正在执行, COMPLETE: 任务成功完成, FAILED: 任务执行失败, EXPIRED: 任务已过期, CANCELED: 任务已被取消', + 'description' => 'CREATED: 创建, RUNNING: 正在执行, COMPLETE: 任务成功完成, FAILED: 任务执行失败, EXPIRED: 任务已过期, CANCELED: 任务已被取消', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + 'enum' => [ + 'CREATED', + 'RUNNING', + 'COMPLETE', + 'FAILED', + ], + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。有关本接口查看返回数据的设置方式，请参见上文接口说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'cae**********699', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回的最大数。取值范围：10~500。默认值：当不设置值或者设置的值小于10，默认值为10。当设置的值大于500时，默认值为500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ListResult<Task>>', + 'description' => 'BaseResponse<ListResult<Task>>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '本次请求所返回的记录集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => 't-0000e4w0u1v592zdf6s7', + ], + 'TaskName' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => ' empty', + ], + 'TaskDescription' => [ + 'description' => '任务描述', + 'type' => 'string', + 'example' => ' empty', + ], + 'TaskType' => [ + 'title' => 'TEST: 测试任务, UPDATE_RESOURCES: 更新资源和状态, CHECK_RULES', + 'description' => 'TEST: 测试任务, UPDATE_RESOURCES: 更新资源和状态, CHECK_RULES', + 'type' => 'string', + 'example' => 'UPDATE_RESOURCES', + ], + 'TaskPriority' => [ + 'title' => 'HIGH: 高优先级，一般为用户前台触发的任务, LOW: 低优先级，一般为后台任务', + 'description' => 'HIGH: 高优先级，一般为用户前台触发的任务, LOW: 低优先级，一般为后台任务', + 'type' => 'string', + 'example' => 'HIGH', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'AE43C4CB-8074-5EBD-9806-8CA6D12800B1', + ], + 'TaskDetail' => [ + 'description' => '任务详情', + 'type' => 'string', + 'example' => '{"resourceTypes":["ACS::ECS::Instance","ACS::OSS::Bucket","ACS::OTS::Instance","ACS::NAS::FileSystem"]}', + ], + 'ExecutionId' => [ + 'description' => '执行ID，暂未使用，返回空', + 'type' => 'string', + 'example' => 'empty', + ], + 'Progress' => [ + 'description' => '进度（0 - 10000）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TaskStatus' => [ + 'title' => 'CREATED: 创建, RUNNING: 正在执行, COMPLETE: 任务成功完成, FAILED: 任务执行失败, EXPIRED: 任务已过期, CANCELED: 任务已被取消', + 'description' => 'CREATED: 创建, RUNNING: 正在执行, COMPLETE: 任务成功完成, FAILED: 任务执行失败, EXPIRED: 任务已过期, CANCELED: 任务已被取消', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'device not online', + ], + 'StartTime' => [ + 'description' => '开始时间，格式为Unix时间戳，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724983927', + ], + 'CompleteTime' => [ + 'description' => '任务完成时间。Unix时间戳格式，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724983927', + ], + 'ExpireTime' => [ + 'description' => '过期时间，格式为Unix时间戳，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724983927', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'example' => 'f4b8c2504545a3b41af5e75147d17d12e3818a0b9b2ff9a2', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => 'AE43C4CB-8074-5EBD-9806-8CA6D12800B1', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"TaskId\\": \\"t-0000e4w0u1v592zdf6s7\\",\\n \\"TaskName\\": \\" empty\\",\\n \\"TaskDescription\\": \\" empty\\",\\n \\"TaskType\\": \\"UPDATE_RESOURCES\\",\\n \\"TaskPriority\\": \\"HIGH\\",\\n \\"RequestId\\": \\"AE43C4CB-8074-5EBD-9806-8CA6D12800B1\\",\\n \\"TaskDetail\\": \\"{\\\\\\"resourceTypes\\\\\\":[\\\\\\"ACS::ECS::Instance\\\\\\",\\\\\\"ACS::OSS::Bucket\\\\\\",\\\\\\"ACS::OTS::Instance\\\\\\",\\\\\\"ACS::NAS::FileSystem\\\\\\"]}\\",\\n \\"ExecutionId\\": \\"empty\\",\\n \\"Progress\\": 100,\\n \\"TaskStatus\\": \\"RUNNING\\",\\n \\"ErrorMessage\\": \\"device not online\\",\\n \\"StartTime\\": 1724983927,\\n \\"CompleteTime\\": 1724983927,\\n \\"ExpireTime\\": 1724983927\\n }\\n ],\\n \\"NextToken\\": \\"f4b8c2504545a3b41af5e75147d17d12e3818a0b9b2ff9a2\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"AE43C4CB-8074-5EBD-9806-8CA6D12800B1\\"\\n}","type":"json"}]', + 'title' => '查询异步任务列表', + 'summary' => '查询异步任务列表。', + ], + 'DescribeTask' => [ + 'path' => '/api/v1/tasks/{TaskId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195923', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID。您可以调用DescribeTasks查看任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't-0004d9ctt1ii********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<Task>', + 'description' => 'BaseResponse<Task>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => 't-xxxxxxxx', + ], + 'TaskName' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'test5566', + ], + 'TaskDescription' => [ + 'description' => '任务描述', + 'type' => 'string', + 'example' => ' empty', + ], + 'TaskType' => [ + 'title' => 'TEST: 测试任务, UPDATE_RESOURCES: 更新资源和状态, CHECK_RULES', + 'description' => '任务类型。UPDATE_RESOURCES: 更新资源和状态, CHECK_RULES', + 'type' => 'string', + 'example' => 'UPDATE_RESOURCES', + ], + 'TaskPriority' => [ + 'title' => 'HIGH: 高优先级，一般为用户前台触发的任务, LOW: 低优先级，一般为后台任务', + 'description' => 'HIGH: 高优先级，一般为用户前台触发的任务, LOW: 低优先级，一般为后台任务', + 'type' => 'string', + 'example' => 'HIGH', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '784076D6-BD6D-5564-9CEA-834EB11F0C62', + ], + 'TaskDetail' => [ + 'description' => '任务执行的详细信息', + 'type' => 'string', + 'example' => '{"resourceTypes":["ACS::ECS::Instance","ACS::OSS::Bucket","ACS::OTS::Instance","ACS::NAS::FileSystem"]}', + ], + 'ExecutionId' => [ + 'description' => '执行ID，暂未使用，返回空', + 'type' => 'string', + 'example' => ' empty', + ], + 'Progress' => [ + 'description' => '进度（0 - 10000）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TaskStatus' => [ + 'title' => 'CREATED: 创建, RUNNING: 正在执行, COMPLETE: 任务成功完成, FAILED: 任务执行失败, EXPIRED: 任务已过期, CANCELED: 任务已被取消', + 'description' => 'CREATED: 创建, RUNNING: 正在执行, COMPLETE: 任务成功完成, FAILED: 任务执行失败, EXPIRED: 任务已过期, CANCELED: 任务已被取消', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ErrorMessage' => [ + 'description' => '任务失败的错误提示。', + 'type' => 'string', + 'example' => 'too many requests.', + ], + 'StartTime' => [ + 'description' => '开始时间，格式为Unix时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724983927', + ], + 'CompleteTime' => [ + 'description' => '任务完成时间。Unix时间戳格式，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724983927', + ], + 'ExpireTime' => [ + 'description' => '过期时间，格式为Unix时间戳，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1719026680', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '14DFF801-A4E3-5136-AAB8-7D246012CD7A', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TaskId\\": \\"t-xxxxxxxx\\",\\n \\"TaskName\\": \\"test5566\\",\\n \\"TaskDescription\\": \\" empty\\",\\n \\"TaskType\\": \\"UPDATE_RESOURCES\\",\\n \\"TaskPriority\\": \\"HIGH\\",\\n \\"RequestId\\": \\"784076D6-BD6D-5564-9CEA-834EB11F0C62\\",\\n \\"TaskDetail\\": \\"{\\\\\\"resourceTypes\\\\\\":[\\\\\\"ACS::ECS::Instance\\\\\\",\\\\\\"ACS::OSS::Bucket\\\\\\",\\\\\\"ACS::OTS::Instance\\\\\\",\\\\\\"ACS::NAS::FileSystem\\\\\\"]}\\",\\n \\"ExecutionId\\": \\" empty\\",\\n \\"Progress\\": 100,\\n \\"TaskStatus\\": \\"RUNNING\\",\\n \\"ErrorMessage\\": \\"too many requests.\\",\\n \\"StartTime\\": 1724983927,\\n \\"CompleteTime\\": 1724983927,\\n \\"ExpireTime\\": 1719026680\\n },\\n \\"RequestId\\": \\"14DFF801-A4E3-5136-AAB8-7D246012CD7A\\"\\n}","type":"json"}]', + 'title' => '查询异步任务', + 'summary' => '查询异步任务详情。', + ], + 'CloseBdrcService' => [ + 'path' => '/api/v1/service/close', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195930', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '663D8898-E0B5-5964-BF28-A191CE6A1825', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"663D8898-E0B5-5964-BF28-A191CE6A1825\\"\\n}","type":"json"}]', + 'title' => '关闭数据灾备中心', + 'summary' => '关闭数据灾备中心。', + ], + 'GetBdrcService' => [ + 'path' => '/api/v1/service', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195922', + 'abilityTreeNodes' => [ + 'FEATUREbdrcVNSW9V', + 'FEATUREbdrcTWEWJD', + 'FEATUREbdrcI7HVLO', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ServiceInfo>', + 'description' => 'BaseResponse<ServiceInfo>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'ServiceStatus' => [ + 'title' => '服务状态 (NOT_OPEN: 未开通, OPENED: 用户已开通服务, CLOSED: 用户已关闭服务)', + 'description' => '服务开启状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CLOSED' => '已关闭', + 'NOT_OPEN' => '未开启', + 'OPENED' => '已开启', + ], + 'example' => 'OPENED', + ], + 'OpenTime' => [ + 'title' => '开通时间', + 'description' => '服务开启时间（UNIX时间）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1726169608', + ], + 'ProtectionScoreUpdatedTime' => [ + 'title' => '评分时间', + 'description' => '数据保护评分更新时间（UNIX时间）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1726169608', + ], + 'ServiceInitializeStatus' => [ + 'description' => '服务初始化状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'SUCCESS' => '初始化成功', + 'FAILED' => '初始化失败', + 'INITIALIZING' => '初始化中', + 'NOT_INITIALIZED' => '未初始化', + ], + 'example' => 'SUCCESS', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '5748C531-80B1-5C31-8421-63A1830B9E48', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ServiceStatus\\": \\"OPENED\\",\\n \\"OpenTime\\": 1726169608,\\n \\"ProtectionScoreUpdatedTime\\": 1726169608,\\n \\"ServiceInitializeStatus\\": \\"SUCCESS\\"\\n },\\n \\"RequestId\\": \\"5748C531-80B1-5C31-8421-63A1830B9E48\\"\\n}","type":"json"}]', + 'title' => '查询数据灾备中心状态', + 'summary' => '查询数据灾备中心状态。', + ], + 'OpenBdrcService' => [ + 'path' => '/api/v1/service/open', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195926', + 'abilityTreeNodes' => [ + 'FEATUREbdrc1FYCXZ', + 'FEATUREbdrcMI318X', + 'FEATUREbdrcP3I6FA', + 'FEATUREbdrcB81P41', + 'FEATUREbdrcOFBTHH', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求的唯一标识', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => '86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9\\"\\n}","type":"json"}]', + 'title' => '开启数据灾备中心', + 'summary' => '开启数据灾备中心。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'bdrc.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'bdrc.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'bdrc.cn-shanghai-finance-1.aliyuncs.com', + ], + ], +]; |