diff options
Diffstat (limited to 'data/en_us/tag')
| -rw-r--r-- | data/en_us/tag/2018-08-28/api-docs.php | 5582 |
1 files changed, 5582 insertions, 0 deletions
diff --git a/data/en_us/tag/2018-08-28/api-docs.php b/data/en_us/tag/2018-08-28/api-docs.php new file mode 100644 index 0000000..b058804 --- /dev/null +++ b/data/en_us/tag/2018-08-28/api-docs.php @@ -0,0 +1,5582 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Tag', + 'version' => '2018-08-28', + ], + 'directories' => [ + [ + 'id' => 71898, + 'title' => 'Resources tag', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + 'ListResourcesByTag', + 'ListTagKeys', + 'ListTagValues', + 'CreateTags', + 'DeleteTag', + 'OpenCreatedBy', + 'CheckCreatedByEnabled', + 'CloseCreatedBy', + 'ListSupportResourceTypes', + 'DescribeRegions', + ], + ], + [ + 'id' => 166919, + 'title' => 'Tag policies', + 'type' => 'directory', + 'children' => [ + 'CreatePolicy', + 'DeletePolicy', + 'AttachPolicy', + 'DetachPolicy', + 'ModifyPolicy', + 'GetPolicy', + 'GetPolicyEnableStatus', + 'ListPolicies', + 'ListPoliciesForTarget', + 'GetEffectivePolicy', + 'ListTargetsForPolicy', + 'ListConfigRulesForTarget', + 'GetConfigRuleReport', + 'GenerateConfigRuleReport', + ], + ], + [ + 'id' => 202967, + 'title' => 'Associated resource tagging', + 'type' => 'directory', + 'children' => [ + 'CreateAssociatedResourceRules', + 'UpdateAssociatedResourceRule', + 'ListAssociatedResourceRules', + 'DeleteAssociatedResourceRule', + ], + ], + [ + 'id' => 182347, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DisablePolicyType', + 'EnablePolicyType', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'TagResources' => [ + 'summary' => 'Adds tags to the resources of various Alibaba Cloud services.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'* If the resources belong to a service that is centrally deployed, set the value to `cn-hangzhou` or to the region ID of the resources by referring to [Regions supported by tag-related operations on resources of centrally deployed Alibaba Cloud services](~~2579691~~).'."\n" + .'* If the resources belong to a service that is not centrally deployed, set the value to the region ID of the resources.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'* If the resources belong to a service that is centrally deployed, set the value to `cn-hangzhou` or to the region ID of the resources by referring to [Regions supported by tag-related operations on resources of centrally deployed Alibaba Cloud services](~~2579691~~).'."\n" + .'* If the resources belong to a service that is not centrally deployed, set the value to the region ID of the resources.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key-value pairs of tags. You can specify 1 to 10 key-value pairs.'."\n" + ."\n" + .'If you specify multiple tags, the system adds all the tags to the specified resources.'."\n" + ."\n" + .'Limits:'."\n" + ."\n" + .'* A tag key must be 1 to 128 characters in length.'."\n" + .'* A tag value must be 1 to 128 characters in length.'."\n" + .'* Tag keys and tag values are case-sensitive.'."\n" + .'* Each tag key on a resource can have only one tag value. If you create a tag that has the same key as an existing tag, the value of the existing tag is overwritten.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"k1":"v1","k2":"v2"}', + ], + ], + [ + 'name' => 'ResourceARN', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of a resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ARN of a resource.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'Format: `arn:acs:${ProductCode}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields:'."\n" + ."\n" + .'* `ProductCode`: the service code. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n" + .'* `Region`: the region ID of the resource. You can set this field to an asterisk (\\*) to indicate the current region.'."\n" + .'* `Account`: the ID of the Alibaba Cloud account to which the resource belongs. You can set this field to an asterisk (\\*) to indicate the current Alibaba Cloud account.'."\n" + .'* `ResourceType`: the resource type. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n" + .'* `ResourceId`: the resource ID.'."\n" + ."\n" + .'> You can set `ProductCode` and `ResourceType` in ResourceARN to values defined in Resource Group, ActionTrail, or Resource Center.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****', + ], + 'required' => true, + 'example' => 'arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****', + 'maxItems' => 101, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '72086426-9F8C-4A60-852B-864048FD1199', + ], + 'FailedResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FailedResource' => [ + 'description' => 'The information about the resources to which tags fail to be added.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If tags are added to all resources, the value of `FailedResources` is empty.'."\n" + ."\n" + .'* If tags fail to be added to some or all resources, the value of `FailedResources` contains the detailed information about the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the resources to which tags fail to be added.', + 'type' => 'object', + 'properties' => [ + 'ResourceARN' => [ + 'description' => 'The ARN of the resource.'."\n", + 'type' => 'string', + 'example' => 'arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****', + ], + 'Result' => [ + 'description' => 'The information about the error.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'InvalidResourceId.NotFound', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The specified ResourceIds are not found in our records.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidResourceARN.Region', + 'errorMessage' => 'The Region specified in the ResourceARN parameter does not match the RegionId parameter, specifically: %s.', + ], + [ + 'errorCode' => 'InvalidResourceARN.Account', + 'errorMessage' => 'The Account specified in the ResourceARN parameter does not match the actual account, specifically: %s.', + ], + [ + 'errorCode' => 'InvalidResourceARN.FormatError', + 'errorMessage' => 'The format of parameter ResourceARN: %s is not valid, for the correct format, you can refer to the Recommend.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The parameter resource type: %s in ResourceARN is not valid or not support.', + ], + [ + 'errorCode' => 'InvalidParameter.ServiceCode', + 'errorMessage' => 'The parameter service code: %s in ResourceARN is not valid or not support.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The TagKey parameter is invalid. The following TagKeys are invalid: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The TagValue parameter is invalid. The following TagValues are invalid: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.Tags', + 'errorMessage' => 'The Tags parameter cannot be empty, and JSON parsing should adhere to the format of a Map.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', + ], + [ + 'errorCode' => 'InvalidParameter.Category', + 'errorMessage' => 'The specified Category is invalid. Valid values are Custom and System.', + ], + [ + 'errorCode' => 'MissingParameter.Createby', + 'errorMessage' => 'You must specify Createby.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceIds.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'NoPermissionKey.Category', + 'errorMessage' => 'Some keys cannot be modified because the user does not have permission.', + ], + [ + 'errorCode' => 'NoPermissionKey.Operator', + 'errorMessage' => 'You are not authorized to operate the tag key.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The maximum number of Tags is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceed.TagsPerResource', + 'errorMessage' => 'The maximum number of tags for each resource is exceeded.', + ], + ], + [ + [ + 'errorCode' => 'Missing.TagKey', + 'errorMessage' => 'Tag.N.Value has been specified and you must specify Tag.N.Key.', + ], + [ + 'errorCode' => 'MissingParameter.AliUid', + 'errorMessage' => 'You must specify AliUid.', + ], + [ + 'errorCode' => 'MissingParameter.Bid', + 'errorMessage' => 'You must specify Bid.', + ], + [ + 'errorCode' => 'MissingParameter.TagKey', + 'errorMessage' => 'You must specify TagKey.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"72086426-9F8C-4A60-852B-864048FD1199\\",\\n \\"FailedResources\\": {\\n \\"FailedResource\\": [\\n {\\n \\"ResourceARN\\": \\"arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****\\",\\n \\"Result\\": {\\n \\"Code\\": \\"InvalidResourceId.NotFound\\",\\n \\"Message\\": \\"The specified ResourceIds are not found in our records.\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<TagResourcesResponse>\\r\\n\\t<RequestId>72086426-9F8C-4A60-852B-864048FD1199</RequestId>\\r\\n\\t<FailedResources></FailedResources>\\r\\n</TagResourcesResponse>\\t\\r\\n\\r\\n","errorExample":""}]', + 'title' => 'TagResources', + 'description' => 'Tags are used to identify resources. Tags allow you to categorize, search for, and aggregate resources that have the same characteristics from different dimensions. This facilitates resource management. For more information, see [Tag overview](~~156983~~).'."\n" + ."\n" + .'For information about the Alibaba Cloud services that support tags, see [Services that work with Tag](~~171455~~).'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => "\n" + ."\n", + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from the resources of various Alibaba Cloud services.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'* If the resources belong to a service that is centrally deployed, set the value to `cn-hangzhou` or to the region ID of the resources by referring to [Regions supported by tag-related operations on resources of centrally deployed Alibaba Cloud services](~~2579691~~).'."\n" + .'* If the resources belong to a service that is not centrally deployed, set the value to the region ID of the resources.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'* If the resources belong to a service that is centrally deployed, set the value to `cn-hangzhou` or to the region ID of the resources by referring to [Regions supported by tag-related operations on resources of centrally deployed Alibaba Cloud services](~~2579691~~).'."\n" + .'* If the resources belong to a service that is not centrally deployed, set the value to the region ID of the resources.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceARN', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of a resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ARN of a resource.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'Format: `arn:acs:${ProductCode}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields:'."\n" + ."\n" + .'* `ProductCode`: the service code. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n" + .'* `Region`: the region ID of the resource. You can set this field to an asterisk (\\*) to indicate the current region.'."\n" + .'* `Account`: the ID of the Alibaba Cloud account to which the resource belongs. You can set this field to an asterisk (\\*) to indicate the current Alibaba Cloud account.'."\n" + .'* `ResourceType`: the resource type. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n" + .'* `ResourceId`: the resource ID.'."\n" + ."\n" + .'> You can set `ProductCode` and `ResourceType` in ResourceARN to values defined in Resource Group, ActionTrail, or Resource Center.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****', + ], + 'required' => true, + 'example' => 'arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****', + 'maxItems' => 101, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The key of tag N.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key of tag N.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'required' => true, + 'example' => 'k1', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '43D12436-B10F-4469-8136-FD1C5D2B2083', + ], + 'FailedResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FailedResource' => [ + 'description' => 'The information about the resources from which tags fail to be removed.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If tags are removed from all resources, the value of FailedResources is empty.'."\n" + ."\n" + .'* If tags fail to be removed from some or all resources, the value of FailedResources contains the detailed information about the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of resources from which tags fail to be removed.', + 'type' => 'object', + 'properties' => [ + 'ResourceARN' => [ + 'description' => 'The ARN of the resource.'."\n", + 'type' => 'string', + 'example' => 'arn:acs:ecs:cn-hangzhou:123456789****:instance/i-xxxxxxxxxx1', + ], + 'Result' => [ + 'description' => 'The information about the error.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'InvalidResourceId.NotFound', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The specified ResourceIds are not found in our records.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidResourceARN.Account', + 'errorMessage' => 'The Account specified in the ResourceARN parameter does not match the actual account, specifically: %s.', + ], + [ + 'errorCode' => 'InvalidResourceARN.FormatError', + 'errorMessage' => 'The format of parameter ResourceARN: %s is not valid, for the correct format, you can refer to the Recommend.', + ], + [ + 'errorCode' => 'InvalidResourceARN.Region', + 'errorMessage' => 'The Region specified in the ResourceARN parameter does not match the RegionId parameter, specifically: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The parameter resource type: %s in ResourceARN is not valid or not support.', + ], + [ + 'errorCode' => 'InvalidParameter.ServiceCode', + 'errorMessage' => 'The parameter service code: %s in ResourceARN is not valid or not support.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The TagKey parameter is invalid. The following TagKeys are invalid: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The TagValue parameter is invalid. The following TagValues are invalid: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', + ], + [ + 'errorCode' => 'InvalidParameter.Category', + 'errorMessage' => 'The specified Category is invalid. Valid values are Custom and System.', + ], + [ + 'errorCode' => 'MissingParameter.Createby', + 'errorMessage' => 'You must specify Createby.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceIds.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'NoPermission.SystemTag', + 'errorMessage' => 'The user does not have permission to operate the system tag.', + ], + [ + 'errorCode' => 'NoPermissionKey.Category', + 'errorMessage' => 'Some keys cannot be modified because the user does not have permission.', + ], + [ + 'errorCode' => 'NoPermissionKey.Operator', + 'errorMessage' => 'You are not authorized to operate the tag key.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The maximum number of Tags is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceed.TagsPerResource', + 'errorMessage' => 'The maximum number of tags for each resource is exceeded.', + ], + [ + 'errorCode' => 'Missing.ServiceCode', + 'errorMessage' => 'You must specify ServiceCode.', + ], + ], + [ + [ + 'errorCode' => 'Missing.TagKey', + 'errorMessage' => 'Tag.N.Value has been specified and you must specify Tag.N.Key.', + ], + [ + 'errorCode' => 'MissingParameter.AliUid', + 'errorMessage' => 'You must specify AliUid.', + ], + [ + 'errorCode' => 'MissingParameter.Bid', + 'errorMessage' => 'You must specify Bid.', + ], + [ + 'errorCode' => 'MissingParameter.TagKey', + 'errorMessage' => 'You must specify TagKey.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"43D12436-B10F-4469-8136-FD1C5D2B2083\\",\\n \\"FailedResources\\": {\\n \\"FailedResource\\": [\\n {\\n \\"ResourceARN\\": \\"arn:acs:ecs:cn-hangzhou:123456789****:instance/i-xxxxxxxxxx1\\",\\n \\"Result\\": {\\n \\"Code\\": \\"InvalidResourceId.NotFound\\",\\n \\"Message\\": \\"The specified ResourceIds are not found in our records.\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UntagResourcesResponse>\\r\\n\\t<RequestId>43D12436-B10F-4469-8136-FD1C5D2B2083</RequestId>\\r\\n\\t<FailedResources></FailedResources>\\r\\n</UntagResourcesResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'UntagResources', + 'description' => 'After you remove a tag, the tag is automatically deleted within 24 hours if it is not added to other resources.'."\n" + ."\n" + .'For information about the Alibaba Cloud services that support tags, see [Services that work with Tag](~~171455~~).'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => "\n", + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags that are added to the resources of various Alibaba Cloud services.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'* If the resources belong to a service that is centrally deployed, set the value to the region ID of the resources by referring to [Regions supported by tag-related operations on resources of centrally deployed Alibaba Cloud services](~~2579691~~).'."\n" + .'* If the resources belong to a service that is not centrally deployed, set the value to the region ID of the resources.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'* If the resources belong to a service that is centrally deployed, set the value to the region ID of the resources by referring to [Regions supported by tag-related operations on resources of centrally deployed Alibaba Cloud services](~~2579691~~).'."\n" + .'* If the resources belong to a service that is not centrally deployed, set the value to the region ID of the resources.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Maximum value: 1000. Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key-value pairs of tags. You can specify 1 to 10 key-value pairs.'."\n" + ."\n" + .'If you specify multiple tags, the system queries the resources to which all these tags are added.'."\n" + ."\n" + .'Limits:'."\n" + ."\n" + .'* A tag key must be 1 to 128 characters in length.'."\n" + .'* A tag value must be 1 to 128 characters in length.'."\n" + .'* Tag keys and tag values are case-sensitive.'."\n" + .'* Each tag key on a resource can have only one tag value. If you create a tag that has the same key as an existing tag, the value of the existing tag is overwritten.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"k1":"v1","k2":"v2"}', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the tag. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n" + .'* All'."\n" + ."\n" + .'Default value: All.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'ResourceARN', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of a resource.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'ARN format: `arn:acs:${ProductCode}:${Region}:${Account}:${ResourceType}/${ResourceId}` Fields:'."\n" + ."\n" + .'* `ProductCode`: the service code. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n" + .'* `Region`: the region ID of the resource. You can set this field to an asterisk (\\*) to indicate the current region.'."\n" + .'* `Account`: the ID of the Alibaba Cloud account to which the resource belongs. You can set this field to an asterisk (\\*) to indicate the current Alibaba Cloud account.'."\n" + .'* `ResourceType`: the resource type. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n" + .'* `ResourceId`: the ID of the resource.'."\n" + ."\n" + .'> You can set `ProductCode` and `ResourceType` in ResourceARN to values defined in Resource Group, ActionTrail, or Resource Center.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ARN of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****', + ], + 'required' => false, + 'example' => 'arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****', + 'maxItems' => 101, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'Indicates whether the `next query` is required.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the `next query` is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the `token` used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '014738E0-3C7F-47D8-8FB9-469500C6F387', + ], + 'TagResources' => [ + 'description' => 'The information of the tags that are added to the resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the tags that are added to the resources.', + 'type' => 'object', + 'properties' => [ + 'ResourceARN' => [ + 'description' => 'The ARN of the resource.'."\n", + 'type' => 'string', + 'example' => 'arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****', + ], + 'Tags' => [ + 'description' => 'The information of the tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Category' => [ + 'description' => 'The type of the tag. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* System'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidResourceARN.Account', + 'errorMessage' => 'The Account specified in the ResourceARN parameter does not match the actual account, specifically: %s.', + ], + [ + 'errorCode' => 'InvalidResourceARN.FormatError', + 'errorMessage' => 'The format of parameter ResourceARN: %s is not valid, for the correct format, you can refer to the Recommend.', + ], + [ + 'errorCode' => 'InvalidResourceARN.Region', + 'errorMessage' => 'The Region specified in the ResourceARN parameter does not match the RegionId parameter, specifically: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The TagKey parameter is invalid. The following TagKeys are invalid: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.Tags', + 'errorMessage' => 'The Tags parameter cannot be empty, and JSON parsing should adhere to the format of a Map.', + ], + [ + 'errorCode' => 'InvalidParameter.RegionId', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', + ], + [ + 'errorCode' => 'InvalidParameter.Category', + 'errorMessage' => 'The specified Category is invalid. Valid values are Custom and System.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceIds.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'NoPermission.SystemTag', + 'errorMessage' => 'The user does not have permission to operate the system tag.', + ], + [ + 'errorCode' => 'NoPermissionKey.Category', + 'errorMessage' => 'Some keys cannot be modified because the user does not have permission.', + ], + [ + 'errorCode' => 'NoPermissionKey.Operator', + 'errorMessage' => 'You are not authorized to operate the tag key.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The maximum number of Tags is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceed.TagsPerResource', + 'errorMessage' => 'The maximum number of tags for each resource is exceeded.', + ], + [ + 'errorCode' => 'Invalid.NextToken', + 'errorMessage' => 'The parameter NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The Tag.N.Value parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + ], + [ + [ + 'errorCode' => 'Missing.TagKey', + 'errorMessage' => 'Tag.N.Value has been specified and you must specify Tag.N.Key.', + ], + [ + 'errorCode' => 'MissingParameter.AliUid', + 'errorMessage' => 'You must specify AliUid.', + ], + [ + 'errorCode' => 'MissingParameter.Bid', + 'errorMessage' => 'You must specify Bid.', + ], + [ + 'errorCode' => 'MissingParameter.RegionId', + 'errorMessage' => 'You must specify RegionId.', + ], + [ + 'errorCode' => 'MissingParameter.RemoveNum', + 'errorMessage' => 'You must specify RemoveNum.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIdARN', + 'errorMessage' => 'You must specify ResourceIdARN.', + ], + [ + 'errorCode' => 'MissingParameter.TagKey', + 'errorMessage' => 'You must specify TagKey.', + ], + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'You must specify Tags.', + ], + [ + 'errorCode' => 'NoMatch.RemoveNum', + 'errorMessage' => 'The specified DataNum does not match the deleted number.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"014738E0-3C7F-47D8-8FB9-469500C6F387\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceARN\\": \\"arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Category\\": \\"Custom\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListTagResourcesResponse>\\r\\n\\t<RequestId>014738E0-3C7F-47D8-8FB9-469500C6F387</RequestId>\\r\\n\\t<NextToken></NextToken>\\r\\n\\t<TagResources>\\r\\n\\t\\t<ResourceARN>arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****</ResourceARN>\\r\\n\\t\\t<Tags>\\r\\n\\t\\t\\t<Category>Custom</Category>\\r\\n\\t\\t\\t<Value>v2</Value>\\r\\n\\t\\t\\t<Key>k2</Key>\\r\\n\\t\\t</Tags>\\r\\n\\t\\t<Tags>\\r\\n\\t\\t\\t<Category>Custom</Category>\\r\\n\\t\\t\\t<Value>v1</Value>\\r\\n\\t\\t\\t<Key>k1</Key>\\r\\n\\t\\t</Tags>\\r\\n\\t</TagResources>\\r\\n\\t<TagResources>\\r\\n\\t\\t<ResourceARN>arn:acs:ecs:cn-hangzhou:123456789****:disk/d-bp16cat8zekjocv4z2fm</ResourceARN>\\r\\n\\t\\t<Tags>\\r\\n\\t\\t\\t<Category>Custom</Category>\\r\\n\\t\\t\\t<Value>v1</Value>\\r\\n\\t\\t\\t<Key>k1</Key>\\r\\n\\t\\t</Tags>\\r\\n\\t\\t<Tags>\\r\\n\\t\\t\\t<Category>Custom</Category>\\r\\n\\t\\t\\t<Value>v2</Value>\\r\\n\\t\\t\\t<Key>k2</Key>\\r\\n\\t\\t</Tags>\\r\\n\\t</TagResources>\\r\\n\\t<TagResources>\\r\\n\\t\\t<ResourceARN>arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****</ResourceARN>\\r\\n\\t\\t<Tags>\\r\\n\\t\\t\\t<Category>Custom</Category>\\r\\n\\t\\t\\t<Value>v2</Value>\\r\\n\\t\\t\\t<Key>k2</Key>\\r\\n\\t\\t</Tags>\\r\\n\\t\\t<Tags>\\r\\n\\t\\t\\t<Category>Custom</Category>\\r\\n\\t\\t\\t<Value>v1</Value>\\r\\n\\t\\t\\t<Key>k1</Key>\\r\\n\\t\\t</Tags>\\r\\n\\t</TagResources>\\r\\n</ListTagResourcesResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListTagResources', + 'description' => 'For information about the Alibaba Cloud services that support tags, see [Services that work with Tag](~~171455~~).'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListResourcesByTag' => [ + 'summary' => 'Queries resources to which a specified tag is added or resources to which a specified tag is not added.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'For more information about region IDs, see [Endpoints](~~2330902~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'For more information about region IDs, see [Endpoints](~~2330902~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 50. Maximum value: 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'* If you set the FuzzyType parameter to EQUAL, you can set this parameter to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n" + .'* If you set the FuzzyType parameter to NOT, you can set this parameter to a resource type provided in **Types of resources that support queries based on the NOT operator**.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ALIYUN::VPC::VPC', + ], + ], + [ + 'name' => 'FuzzyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the query. Valid values:'."\n" + ."\n" + .'* EQUAL: exact match for resources to which the specified tag is added. This is the default value.'."\n" + .'* NOT: exact match for resources to which the specified tag is not added.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EQUAL', + ], + ], + [ + 'name' => 'TagFilter.Value', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag value. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + [ + 'name' => 'TagFilter.Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'The tag key can be a maximum of 128 characters in length. It cannot contain `http://` or `https://` and cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'k1', + ], + ], + [ + 'name' => 'IncludeAllTags', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the information of tags added to the resources. Valid values:'."\n" + ."\n" + .'* False: does not return the information of tags added to the resources. This is the default value.'."\n" + .'* True: returns the information of all tags added to the resources.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7D61FF74-61C2-5768-B01F-05FC97F24F35', + ], + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空或者空字符串代表数据已经读取完毕', + 'description' => 'Indicates whether the `next query` is required.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the `next query` is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the `token` used to start the next query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'Resources' => [ + 'description' => 'The information of the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the resources.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'vpc-wz9pifyuw26esxd05****', + ], + 'Tags' => [ + 'description' => 'The information of the tags.'."\n" + ."\n" + .'This parameter is returned only if the `IncludeAllTags` parameter is set to `True`.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'k1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Category' => [ + 'description' => 'The type of the tag. Valid values:'."\n" + ."\n" + .'* custom'."\n" + .'* system'."\n", + 'type' => 'string', + 'example' => 'custom', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid.MsgEndPoint', + 'errorMessage' => 'The MsgEndPoint is invalid.', + ], + [ + 'errorCode' => 'Invalid.MsgQueue', + 'errorMessage' => 'The MsgQueue is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Tags', + 'errorMessage' => 'The specified value of parameter Tags is not valid.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains duplicate keys, please check the duplicate tag key.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The TagKey parameter is invalid. The following TagKeys are invalid: %s.', + ], + [ + 'errorCode' => 'MetaTagKeyHasValue', + 'errorMessage' => 'The specified TagKey already bind tag value', + ], + [ + 'errorCode' => 'NumberExceed.TagKeys', + 'errorMessage' => 'The maximum number of TagKeys is exceeded.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The TagValue parameter is invalid. The following TagValues are invalid: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Invalid.NextToken', + 'errorMessage' => 'The parameter NextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParamter.NextToken', + 'errorMessage' => 'NextToken parameter is illegal.', + ], + [ + 'errorCode' => 'FuzzyType.NotSupport', + 'errorMessage' => 'Fuzzy queries are not supported.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The maximum number of Tags is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceed.TagsPerResource', + 'errorMessage' => 'The maximum number of tags for each resource is exceeded.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', + ], + [ + 'errorCode' => 'InvalidParameter.Key', + 'errorMessage' => 'The Key is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + [ + 'errorCode' => 'MetaTagKey.BindingResources', + 'errorMessage' => 'Binding resource exists for tag key.', + ], + [ + 'errorCode' => 'MetaTagKeyNotFound', + 'errorMessage' => 'The meta tag key is not found.', + ], + [ + 'errorCode' => 'NoPermissionKey.Category', + 'errorMessage' => 'Some keys cannot be modified because the user does not have permission.', + ], + [ + 'errorCode' => 'NoPermissionKey.Operator', + 'errorMessage' => 'You are not authorized to operate the tag key.', + ], + [ + 'errorCode' => 'InvalidParameter.Category', + 'errorMessage' => 'The specified Category is invalid. Valid values are Custom and System.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The Tag.N.Value parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Value', + 'errorMessage' => 'The Value is invalid.', + ], + ], + [ + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'You must specify Tags.', + ], + [ + 'errorCode' => 'Missing.TagKey', + 'errorMessage' => 'Tag.N.Value has been specified and you must specify Tag.N.Key.', + ], + [ + 'errorCode' => 'MissingParameter.Key', + 'errorMessage' => 'The Key must not be empty.', + ], + [ + 'errorCode' => 'MissingParameter.TagKey', + 'errorMessage' => 'You must specify TagKey.', + ], + [ + 'errorCode' => 'MissingParameter.TagKeyValueParamList', + 'errorMessage' => 'The parameter TagKeyValueParamList must not be null.', + ], + [ + 'errorCode' => 'MissingParameter.Value', + 'errorMessage' => 'The Value must not be empty.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7D61FF74-61C2-5768-B01F-05FC97F24F35\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"Resources\\": [\\n {\\n \\"ResourceId\\": \\"vpc-wz9pifyuw26esxd05****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Category\\": \\"custom\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListResourcesByTagResponse>\\n <RequestId>7D61FF74-61C2-5768-B01F-05FC97F24F35</RequestId>\\n <NextToken/>\\n <Resources>\\n <ResourceId>vpc-wz9pifyuw26esxd05****</ResourceId>\\n </Resources>\\n <Resources>\\n <ResourceId>vpc-wz9qpfj5nej4ofnzu****</ResourceId>\\n </Resources>\\n</ListResourcesByTagResponse>","errorExample":""}]', + 'title' => 'ListResourcesByTag', + 'description' => 'This topic provides an example on how to call the API operation in the China (Shenzhen) region to query virtual private clouds (VPCs) to which the tag key `k1` is added. The response shows that the tag key is added to two VPCs.', + 'requestParamsDescription' => '**Types of resources that support queries based on the NOT operator:**'."\n" + ."\n" + .'* ALIYUN::ADB::CLUSTER'."\n" + .'* ALIYUN::ALB::ACL'."\n" + .'* ALIYUN::ALB::LOADBALANCER'."\n" + .'* ALIYUN::ALB::SECURITYPOLICY'."\n" + .'* ALIYUN::ALB::SERVERGROUP'."\n" + .'* ALIYUN::ALIDNS::DOMAIN'."\n" + .'* ALIYUN::BASTIONHOST::INSTANCE'."\n" + .'* ALIYUN::BPSTUDIO::APPLICATION'."\n" + .'* ALIYUN::BPSTUDIO::TEMPLATE'."\n" + .'* ALIYUN::CAS::INSTANCE'."\n" + .'* ALIYUN::CDN::DOMAIN'."\n" + .'* ALIYUN::CDS::CLUSTER'."\n" + .'* ALIYUN::CEN::BANDWIDTHPACKAGE'."\n" + .'* ALIYUN::CEN::CEN'."\n" + .'* ALIYUN::CS::CLUSTER'."\n" + .'* ALIYUN::DBAUDIT::INSTANCE'."\n" + .'* ALIYUN::DCDN::DOMAIN'."\n" + .'* ALIYUN::DDOSBGP::INSTANCE'."\n" + .'* ALIYUN::DDOSCOO::INSTANCE'."\n" + .'* ALIYUN::DDS::INSTANCE'."\n" + .'* ALIYUN::DRDS::INSTANCE'."\n" + .'* ALIYUN::ECS::DDH'."\n" + .'* ALIYUN::ECS::DDHCLUSTER'."\n" + .'* ALIYUN::ECS::DISK'."\n" + .'* ALIYUN::ECS::ENI'."\n" + .'* ALIYUN::ECS::INSTANCE'."\n" + .'* ALIYUN::ECS::KEYPAIR'."\n" + .'* ALIYUN::ECS::LAUNCHTEMPLATE'."\n" + .'* ALIYUN::ECS::SECURITYGROUP'."\n" + .'* ALIYUN::ECS::SNAPSHOT'."\n" + .'* ALIYUN::EDAS::APPLICATION'."\n" + .'* ALIYUN::EDAS::CLUSTER'."\n" + .'* ALIYUN::ELASTICSEARCH::INSTANCE'."\n" + .'* ALIYUN::EMR::CLUSTER'."\n" + .'* ALIYUN::EMR::FLOWPROJECT'."\n" + .'* ALIYUN::HBR::CLIENT'."\n" + .'* ALIYUN::HBR::HANAINSTANCE'."\n" + .'* ALIYUN::HBR::VAULT'."\n" + .'* ALIYUN::KVSTORE::INSTANCE'."\n" + .'* ALIYUN::MULTIMOD::CLUSTER'."\n" + .'* ALIYUN::OCEANBASE::INSTANCE'."\n" + .'* ALIYUN::OOS::EXECUTION'."\n" + .'* ALIYUN::OOS::PARAMETER'."\n" + .'* ALIYUN::OOS::SECRETPARAMETER'."\n" + .'* ALIYUN::OOS::STATECONFIGURATION'."\n" + .'* ALIYUN::OOS::TEMPLATE'."\n" + .'* ALIYUN::OSS::BUCKET'."\n" + .'* ALIYUN::OUTBOUNDBOT::INSTANCE'."\n" + .'* ALIYUN::POLARDB::CLUSTER'."\n" + .'* ALIYUN::PVTZ::ZONE'."\n" + .'* ALIYUN::RDS::INSTANCE'."\n" + .'* ALIYUN::VPC::COMMONBANDWIDTHPACKAGE'."\n" + .'* ALIYUN::VPC::EIP'."\n" + .'* ALIYUN::VPC::NATGATEWAY'."\n" + .'* ALIYUN::VPC::VPC'."\n", + ], + 'ListTagKeys' => [ + 'summary' => 'Queries tag keys.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'For more information about region IDs, see [Endpoints](~~2330902~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'For more information about region IDs, see [Endpoints](~~2330902~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of tag keys to return on each page.'."\n" + ."\n" + .'Maximum value: 1000. Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource tags. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* all (default value)'."\n" + .'* custom'."\n" + .'* system'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'Format: `ALIYUN::${ProductCode}::${ResourceType}`. All letters in the value of this parameter must be in uppercase.'."\n" + ."\n" + .'* `ProductCode`: the service code. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n" + .'* `ResourceType`: the resource type. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN::ECS::INSTANCE', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the tags. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* ResourceTag: resource tags, including custom and system tags. This is the default value.'."\n" + .'* MetaTag: preset tags.'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceTag', + ], + ], + [ + 'name' => 'FuzzyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the query. Valid values:'."\n" + ."\n" + .'* EQUAL (default): exact match'."\n" + .'* PREFIX: prefix-based fuzzy match'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EQUAL', + ], + ], + [ + 'name' => 'TagFilter.Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key for a fuzzy query.'."\n" + ."\n" + .'This parameter is used together with the `FuzzyType` parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'team', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required. The value of this parameter may be empty.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC09A6AA-2713-4E10-A2E9-E6C5C43A8842', + ], + 'Keys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Key' => [ + 'description' => 'The information of the tag keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the tag keys.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'team', + ], + 'Category' => [ + 'description' => 'The type of the resource tag. Valid values:'."\n" + ."\n" + .'* custom'."\n" + .'* system'."\n", + 'type' => 'string', + 'example' => 'custom', + ], + 'Description' => [ + 'description' => 'The description of the tag key.'."\n", + 'type' => 'string', + 'example' => 'Business team', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FuzzyQuery.NotSupport', + 'errorMessage' => 'The fuzzy query is not supported.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Invalid.NextToken', + 'errorMessage' => 'The parameter NextToken is invalid.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'InvalidParameter.Category', + 'errorMessage' => 'The specified Category is invalid. Valid values are Custom and System.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"DC09A6AA-2713-4E10-A2E9-E6C5C43A8842\\",\\n \\"Keys\\": {\\n \\"Key\\": [\\n {\\n \\"Key\\": \\"team\\",\\n \\"Category\\": \\"custom\\",\\n \\"Description\\": \\"业务团队\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListTagKeysResponse>\\r\\n\\t<NextToken></NextToken>\\r\\n\\t<RequestId>DC09A6AA-2713-4E10-A2E9-E6C5C43A8842</RequestId>\\r\\n\\t<Keys>\\r\\n\\t\\t<Key>\\r\\n\\t\\t\\t<Category>custom</Category>\\r\\n\\t\\t\\t<Key>team</Key>\\r\\n\\t\\t</Key>\\r\\n\\t\\t<Key>\\r\\n\\t\\t\\t<Category>custom</Category>\\r\\n\\t\\t\\t<Key>k1</Key>\\r\\n\\t\\t</Key>\\r\\n\\t\\t<Key>\\r\\n\\t\\t\\t<Category>custom</Category>\\r\\n\\t\\t\\t<Key>k2</Key>\\r\\n\\t\\t</Key>\\r\\n\\t</Keys>\\r\\n</ListTagKeysResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListTagKeys', + 'description' => 'This topic provides an example on how to call the API operation to query the tag keys in the `cn-hangzhou` region. The response shows that the following tag keys exist: `team`, `k1`, and `k2`.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagValues' => [ + 'summary' => 'Queries the tag values of a tag key.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'For more information about region IDs, see [Endpoints](~~2330902~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'For more information about region IDs, see [Endpoints](~~2330902~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key. This parameter specifies a filter condition for the query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'k1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of tag values to return on each page.'."\n" + ."\n" + .'Maximum value: 1000. Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'Format: `ALIYUN::${ProductCode}::${ResourceType}`. All letters in the value of this parameter must be in uppercase.'."\n" + ."\n" + .'* `ProductCode`: the service code. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n" + .'* `ResourceType`: the resource type. You can set this field to a value obtained from the response of the [ListSupportResourceTypes](~~2330915~~) operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN::ECS::INSTANCE', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the tags. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* ResourceTag: resource tags, including custom and system tags. This is the default value.'."\n" + .'* MetaTag: preset tags.'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceTag', + ], + ], + [ + 'name' => 'FuzzyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the query. Valid values:'."\n" + ."\n" + .'* EQUAL (default): exact match'."\n" + .'* PREFIX: prefix-based fuzzy match'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EQUAL', + ], + ], + [ + 'name' => 'TagFilter.Value', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag value for a fuzzy query.'."\n" + ."\n" + .'This parameter is used together with the `FuzzyType` parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required. The value of this parameter may be empty.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8989CA7E-D2E0-4B6D-8282-311106E80150', + ], + 'Values' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Value' => [ + 'description' => 'The information of the tag values.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the tag values.', + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FuzzyQuery.NotSupport', + 'errorMessage' => 'The fuzzy query is not supported.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Invalid.NextToken', + 'errorMessage' => 'The parameter NextToken is invalid.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'NoPermissionKey.Operator', + 'errorMessage' => 'You are not authorized to operate the tag key.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + [ + 'errorCode' => 'MetaTagKeyNotFound', + 'errorMessage' => 'The meta tag key is not found.', + ], + ], + [ + [ + 'errorCode' => 'Missing.TagKey', + 'errorMessage' => 'Tag.N.Value has been specified and you must specify Tag.N.Key.', + ], + [ + 'errorCode' => 'MissingParameter.TagKey', + 'errorMessage' => 'You must specify TagKey.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"8989CA7E-D2E0-4B6D-8282-311106E80150\\",\\n \\"Values\\": {\\n \\"Value\\": [\\n \\"v1\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ListTagValuesResponse>\\r\\n\\t<NextToken></NextToken>\\r\\n\\t<RequestId>8989CA7E-D2E0-4B6D-8282-311106E80150</RequestId>\\r\\n\\t<Values>\\r\\n\\t\\t<Value>v1</Value>\\r\\n\\t</Values>\\r\\n</ListTagValuesResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'ListTagValues', + 'description' => 'This topic provides an example on how to call the API operation to query the values of the tag key `k1` in the `cn-hangzhou` region. The response shows that the value of the tag key `k1` is `v1`.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateTags' => [ + 'summary' => 'Creates predefined tags.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> Only `cn-hangzhou` is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TagKeyValueParamList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key of tag N.'."\n" + ."\n" + .'The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The value of tag N.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Environment', + ], + 'TagValueParamList' => [ + 'description' => 'The information about the tag values.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of tag N.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of tag N.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Description' => [ + 'description' => 'The description of the value for tag N.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test environment', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + 'Description' => [ + 'description' => 'The description of the key for tag N.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Business environment', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '94E16BB6-3FB6-1297-B5B2-ED2250F437CD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MetaTagKeyHasValue', + 'errorMessage' => 'The specified TagKey already bind tag value', + ], + ], + 403 => [ + [ + 'errorCode' => 'WrongEndpoint', + 'errorMessage' => 'Only the central endpoint supports the create and delete operation of meta tag.', + ], + [ + 'errorCode' => 'InvalidParameter.Key', + 'errorMessage' => 'The Key is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.Value', + 'errorMessage' => 'The Value is invalid.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'MetaTagKey.BindingResources', + 'errorMessage' => 'Binding resource exists for tag key.', + ], + [ + 'errorCode' => 'MetaTagKeyNotFound', + 'errorMessage' => 'The meta tag key is not found.', + ], + ], + [ + [ + 'errorCode' => 'MissingParameter.TagKeyValueParamList', + 'errorMessage' => 'The parameter TagKeyValueParamList must not be null.', + ], + [ + 'errorCode' => 'MissingParameter.Key', + 'errorMessage' => 'The Key must not be empty.', + ], + [ + 'errorCode' => 'MissingParameter.Value', + 'errorMessage' => 'The Value must not be empty.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"94E16BB6-3FB6-1297-B5B2-ED2250F437CD\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreateTagsResponse>\\r\\n\\t<RequestId>94E16BB6-3FB6-1297-B5B2-ED2250F437CD</RequestId>\\r\\n</CreateTagsResponse>","errorExample":""}]', + 'title' => 'CreateTags', + 'description' => '###'."\n" + ."\n" + .'A preset tag is a tag that you create in advance and is available for the resources in all regions. You can create preset tags in the stage of tag planning and add them to specific resources in the stage of tag implementation. When you create a preset tag, you can specify only the tag key. You can specify a tag value in the future.'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to create a preset tag whose tag key is `Environment` to indicate the business environment.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteTag' => [ + 'summary' => 'Deletes a preset tag.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> Only `cn-hangzhou` is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key.'."\n" + ."\n" + .'If no tag value is associated with a tag key, you can specify the `Key` parameter without specifying the Value parameter to delete the tag key. Otherwise, you must specify both the `Key` and `Value` parameters to delete a preset tag.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Environment', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6E27F22C-EDA3-132E-A53F-77DE3BC2343D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MetaTagKeyHasValue', + 'errorMessage' => 'The specified TagKey already bind tag value', + ], + ], + 403 => [ + [ + 'errorCode' => 'WrongEndpoint', + 'errorMessage' => 'Only the central endpoint supports the create and delete operation of meta tag.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'MetaTagKeyNotFound', + 'errorMessage' => 'The meta tag key is not found.', + ], + ], + [ + [ + 'errorCode' => 'MissingParameter.Key', + 'errorMessage' => 'The Key must not be empty.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E27F22C-EDA3-132E-A53F-77DE3BC2343D\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteTagResponse>\\r\\n\\t<RequestId>6E27F22C-EDA3-132E-A53F-77DE3BC2343D</RequestId>\\r\\n</DeleteTagResponse>","errorExample":""}]', + 'title' => 'DeleteTag', + 'description' => 'This topic provides an example on how to call the API operation to delete the preset tag whose tag key is `Environment` and tag value is `test`.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OpenCreatedBy' => [ + 'summary' => 'Enables createdby tags.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '74F03511-FDFA-54AF-96A4-71575B41E74D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CreatedByAlreadyOpen', + 'errorMessage' => 'CreatedBy is already activated.', + ], + [ + 'errorCode' => 'InvalidOperation.NotActivated', + 'errorMessage' => 'The associated resources service has not been activated.', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => 'Only a primary account can perform the operation.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'The role not exists.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'AssumedRoleUser has no permission.', + ], + [ + 'errorCode' => 'Operation.NotActivated', + 'errorMessage' => 'This function is not activated.', + ], + [ + 'errorCode' => 'MissingParameter.Createby', + 'errorMessage' => 'You must specify Createby.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"74F03511-FDFA-54AF-96A4-71575B41E74D\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenCreatedByResponse>\\n <RequestId>74F03511-FDFA-54AF-96A4-71575B41E74D</RequestId>\\n</OpenCreatedByResponse>","errorExample":""}]', + 'title' => 'OpenCreatedBy', + 'description' => 'createdby tags can help you analyze costs and bills and manage the costs of cloud resources in an efficient manner. You can identify the creators of resources based on the createdby tags added to the resources. createdby tags are system tags that are provided by Alibaba Cloud and automatically added to resources. The key of createdby tags is `acs:tag:createdby`.'."\n", + ], + 'CheckCreatedByEnabled' => [ + 'summary' => 'Checks whether the createdby tag is enabled.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance resides.'."\n" + ."\n" + .'Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '682DD9E1-F530-5D14-A839-A6787FA8****', + ], + 'OpenStatus' => [ + 'description' => 'Indicates whether the createdby tag is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Throttling', + 'errorMessage' => 'You have exceeded the maximum traffic. To increase the limit, submit a ticket.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"682DD9E1-F530-5D14-A839-A6787FA8****\\",\\n \\"OpenStatus\\": false\\n}","type":"json"}]', + 'title' => 'CheckCreatedByEnabled', + ], + 'CloseCreatedBy' => [ + 'summary' => 'Disables createdby tags.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance resides.'."\n" + ."\n" + .'Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'AECFE0F2-CEC3-5D16-BE4C-E2F95083****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => 'Only a primary account can perform the operation.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'The role not exists.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'AssumedRoleUser has no permission.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AECFE0F2-CEC3-5D16-BE4C-E2F95083****\\"\\n}","type":"json"}]', + 'title' => 'CloseCreatedBy', + ], + 'ListSupportResourceTypes' => [ + 'summary' => 'Queries the resource types supported by tags and tag-related capability items.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'For more information about region IDs, see [Endpoints](~~2330902~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Maximum value: 1000. Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAYws9fJ0Ur4MGm/5OkDoW/Y3wDNwUdssyKODK****', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service code. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'This parameter is obtained from the response.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ResourceTye', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'This parameter is obtained from the response.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ShowItems', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return tag-related capability items. Valid values:'."\n" + ."\n" + .'* true: The system returns tag-related capability items.'."\n" + .'* false (default value): The system does not return tag-related capability items.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SupportCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the tag-related capability item. This parameter specifies a filter condition for the query.'."\n" + ."\n" + .'For more information, see **Tag-related capability items**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TAG_CONSOLE_SUPPORT', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResponse<PolicyModel>', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'SupportResourceTypes' => [ + 'description' => 'The supported resource types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A supported resource type.'."\n", + 'type' => 'object', + 'properties' => [ + 'ProductCode' => [ + 'description' => 'The service code.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'ResourceType' => [ + 'description' => 'The resource type.'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'SupportItems' => [ + 'description' => 'The supported tag-related capability items.'."\n" + ."\n" + .'> This parameter is returned only if the `ShowItems` parameter is set to `true`.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The supported tag-related capability items.', + 'type' => 'object', + 'properties' => [ + 'SupportCode' => [ + 'description' => 'The code of the tag-related capability item.'."\n", + 'type' => 'string', + 'example' => 'TAG_CONSOLE_SUPPORT', + ], + 'Support' => [ + 'description' => 'Indicates whether the tag-related capability item is supported. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SupportDetails' => [ + 'description' => 'The details of the support for the tag-related capability item.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the support for the tag-related capability item.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The code of the support. For more information, see **Codes of the support for tag-related capability items**.'."\n", + 'example' => 'ApiName', + ], + ], + ], + ], + ], + ], + 'ArnTemplate' => [ + 'description' => 'The resource ARN template.'."\n", + 'type' => 'string', + 'example' => 'acs:ecs:*:*:instance/${ResourceId}', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'ABC71772-F3A1-59CA-B811-4A5B0E0B72F8', + ], + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required.'."\n" + ."\n" + .'* If the value of this parameter is empty, all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'AAAAAYws9fJ0Ur4MGm****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidParameter.SupportCode', + 'errorMessage' => 'SupportCode parameter is illegal.', + ], + ], + [ + [ + 'errorCode' => 'Missing.Data', + 'errorMessage' => 'The data that you want to operate does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SupportResourceTypes\\": [\\n {\\n \\"ProductCode\\": \\"ecs\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"SupportItems\\": [\\n {\\n \\"SupportCode\\": \\"TAG_CONSOLE_SUPPORT\\",\\n \\"Support\\": true,\\n \\"SupportDetails\\": [\\n {\\n \\"key\\": \\"ApiName\\"\\n }\\n ]\\n }\\n ],\\n \\"ArnTemplate\\": \\"acs:ecs:*:*:instance/${ResourceId}\\"\\n }\\n ],\\n \\"RequestId\\": \\"ABC71772-F3A1-59CA-B811-4A5B0E0B72F8\\",\\n \\"NextToken\\": \\"AAAAAYws9fJ0Ur4MGm\\"\\n}","errorExample":""},{"type":"xml","example":"<ListSupportResourceTypesResponse>\\n <RequestId>ABC71772-F3A1-59CA-B811-4A5B0E0B72F8</RequestId>\\n <NextToken>AAAAAYws9fJ0Ur4MGm/5OkDoW/Y3wDNwUdssyKODK+myOlBL</NextToken>\\n <SupportResourceTypes>\\n <ProductCode>ecs</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>ros</ProductCode>\\n <ResourceType>template</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>kvstore</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>alikafka</ProductCode>\\n <ResourceType>consumergroup</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>ddoscoo</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>polardb</ProductCode>\\n <ResourceType>cluster</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>vod</ProductCode>\\n <ResourceType>domain</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>multimod</ProductCode>\\n <ResourceType>cluster</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>cas</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>sae</ProductCode>\\n <ResourceType>application</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>hitsdb</ProductCode>\\n <ResourceType>Instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>cloudphone</ProductCode>\\n <ResourceType>Instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>bastionhost</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>dds</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>adb</ProductCode>\\n <ResourceType>cluster</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>baas</ProductCode>\\n <ResourceType>organization</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>nas</ProductCode>\\n <ResourceType>filesystem</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>scblinkonecs</ProductCode>\\n <ResourceType>cluster</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>mq</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>slb</ProductCode>\\n <ResourceType>certificate</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>polardbx</ProductCode>\\n <ResourceType>PolarDBXInstance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>avds</ProductCode>\\n <ResourceType>assets</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>dbaudit</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>cdn</ProductCode>\\n <ResourceType>domain</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>live</ProductCode>\\n <ResourceType>domain</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>alidns</ProductCode>\\n <ResourceType>domain</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>dts</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>vpc</ProductCode>\\n <ResourceType>natgateway</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>elasticsearch</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>alb</ProductCode>\\n <ResourceType>loadbalancer</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>gpdb</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>savingplan</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>petadata</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>dysms</ProductCode>\\n <ResourceType>template</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>fc</ProductCode>\\n <ResourceType>service</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>hsm</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>hcs_sgw</ProductCode>\\n <ResourceType>gateway</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>hologram</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>cms</ProductCode>\\n <ResourceType>monitorgroup</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>smc</ProductCode>\\n <ResourceType>replicationjob</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>ddosbgp</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>rds</ProductCode>\\n <ResourceType>backup</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>gws</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>oss</ProductCode>\\n <ResourceType>bucket</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>ecs</ProductCode>\\n <ResourceType>imagecomponent</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>apigateway</ProductCode>\\n <ResourceType>plugin</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>drds</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>pvtz</ProductCode>\\n <ResourceType>zone</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>hbr</ProductCode>\\n <ResourceType>hanainstance</ResourceType>\\n </SupportResourceTypes>\\n <SupportResourceTypes>\\n <ProductCode>slb</ProductCode>\\n <ResourceType>instance</ResourceType>\\n </SupportResourceTypes>\\n</ListSupportResourceTypesResponse>","errorExample":""}]', + 'title' => 'ListSupportResourceTypes', + 'description' => '### [](#)Call example'."\n" + ."\n" + .'* Query a list of resource types supported by TagResources or UntagResources. For more information, see [Example](https://api.alibabacloud.com/api/Tag/2018-08-28/ListSupportResourceTypes?tab=DEBUG\\¶ms=%7B%22RegionId%22:%22cn-hangzhou%22,%22SupportCode%22:%22TAG_CONSOLE_SUPPORT%22%7D).'."\n" + .'* Query a list of resource types supported by ListTagResources or ListResourcesByTag. For more information, see [Example](https://api.alibabacloud.com/api/Tag/2018-08-28/ListSupportResourceTypes?tab=DEBUG\\¶ms=%7B%22RegionId%22:%22cn-hangzhou%22%7D).'."\n" + .'* Query a list of resource types that support createdby tags. For more information, see [Example](https://api.alibabacloud.com/api/Tag/2018-08-28/ListSupportResourceTypes?tab=DEBUG\\¶ms=%7B%22RegionId%22:%22cn-hangzhou%22,%22SupportCode%22:%22CREATED_BY_TAG_CONSOLE_SUPPORT%22%7D).'."\n", + 'requestParamsDescription' => '### Tag-related capability items'."\n" + ."\n" + .'|Code of a tag-related capability item|Description|'."\n" + .'|---|---|'."\n" + .'|TAG\\_CONSOLE\\_SUPPORT|Specifies whether a resource type is supported by the Resource Management console.|'."\n" + .'|CLOUD\\_RESOURCE\\_CONSOLE\\_SUPPORT|Specifies whether the console of a service supports tags.|'."\n" + .'|TAG\\_RAM\\_SUPPORT|Specifies whether tags can be used to verify the permissions of users on resources of a specific type.|'."\n" + .'|CLOUD\\_RESOURCE\\_API\\_SUPPORT|Specifies whether the API operations that are used to query resources support tags.|'."\n" + .'|TAG\\_API\\_SUPPORT|Specifies whether a service provides tag-related API operations.Tag-related API operations include TagResources, UntagResources, and ListTagResources.|'."\n" + .'|TAG\\_BILL\\_SUPPORT|Specifies whether cost allocation by tag is supported.|'."\n" + .'|CREATED\\_BY\\_TAG\\_BILL\\_SUPPORT|Specifies whether cost allocation based on createdby tags is supported.|'."\n" + .'|CREATED\\_BY\\_TAG\\_CONSOLE\\_SUPPORT|Specifies whether the console of a service supports createdby tags.|'."\n" + .'|TAG\\_POLICY\\_PREVENTATIVE\\_CHECK\\_SUPPORT|Specifies whether the pre-detection feature of tag policies is supported. This feature enables the system to check whether a tag complies with the rules defined in a tag policy when you add the tag to a resource. If the tag does not comply with the rules, the tag fails to be added to the resource.|'."\n" + .'|TAG\\_POLICY\\_CHECK\\_REMEDIATION\\_SUPPORT|Specifies whether the post-detection and automatic remediation features of tag policies are supported.The post-detection feature enables the system to check whether the tags that are added to a resource comply with the rules defined in a tag policy. The automatic remediation feature enables the system to correct the tags that do not comply with the rules.|'."\n" + .'|TAG\\_POLICY\\_RG\\_TAG\\_INHERIT\\_SUPPORT|Specifies whether resource group-based tag inheritance defined in a tag policy is supported. If resource group-based tag inheritance is enabled in a tag policy, resources inherit tags from the resource groups to which they belong.|', + 'responseParamsDescription' => '### Codes of the support for tag-related capability items'."\n" + ."\n" + .'|Code|Description|'."\n" + .'|---|---|'."\n" + .'|ApiName|The name of the API operation supported by a tag-related capability item.|'."\n" + .'|SupportEnforcedForTags|Indicates whether the API operation supports the strong verification feature for pre-event interception.|', + ], + 'DescribeRegions' => [ + 'summary' => 'Queries the regions where the Tag service is available.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The supported natural language. Valid values:'."\n" + ."\n" + .'* zh-CN: Chinese (default value)'."\n" + .'* en-US: English'."\n" + .'* ja: Japanese'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '632BBAE2-9C44-4212-8B51-B54742DA9713', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The information of the regions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the regions.', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => 'The name of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)', + ], + 'RegionEndpoint' => [ + 'description' => 'The endpoint of the Tag service in the region.'."\n", + 'type' => 'string', + 'example' => 'tag.aliyuncs.com', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidParameter.AcceptLanguage', + 'errorMessage' => 'The specified value of parameter AcceptLanguage is not valid.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"632BBAE2-9C44-4212-8B51-B54742DA9713\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"RegionEndpoint\\": \\"tag.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>4090BC47-A3FE-52D2-98D9-5D0725C530A2</RequestId>\\n <Regions>\\n <Region>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东1（杭州）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-shanghai</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东2（上海）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-hangzhou-finance</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东1 金融云</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-nanjing</RegionId>\\n <RegionEndpoint>tag.cn-nanjing.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东5（南京-本地地域）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-shanghai-finance-1</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东2 金融云</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-fuzhou</RegionId>\\n <RegionEndpoint>tag.cn-fuzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东6（福州-本地地域）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-qingdao</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北1（青岛）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-beijing</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北2（北京）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-zhangjiakou</RegionId>\\n <RegionEndpoint>tag.cn-zhangjiakou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北3（张家口）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-huhehaote</RegionId>\\n <RegionEndpoint>tag.cn-huhehaote.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北5（呼和浩特）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-wulanchabu</RegionId>\\n <RegionEndpoint>tag.cn-wulanchabu.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北6（乌兰察布）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-beijing-finance-1</RegionId>\\n <RegionEndpoint>tag.cn-beijing-finance-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北2 金融云</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-shenzhen</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1（深圳）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-shenzhen-finance-1</RegionId>\\n <RegionEndpoint>tag.cn-shenzhen-finance-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1 金融云</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-heyuan</RegionId>\\n <RegionEndpoint>tag.cn-heyuan.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南2（河源）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-guangzhou</RegionId>\\n <RegionEndpoint>tag.cn-guangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南3（广州）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-chengdu</RegionId>\\n <RegionEndpoint>tag.cn-chengdu.aliyuncs.com</RegionEndpoint>\\n <LocalName>西南1（成都）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-hongkong</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>中国香港</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-1</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>新加坡</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-2</RegionId>\\n <RegionEndpoint>tag.ap-southeast-2.aliyuncs.com</RegionEndpoint>\\n <LocalName>澳大利亚（悉尼）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-northeast-2</RegionId>\\n <RegionEndpoint>tag.ap-northeast-2.aliyuncs.com</RegionEndpoint>\\n <LocalName>韩国（首尔）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-3</RegionId>\\n <RegionEndpoint>tag.ap-southeast-3.aliyuncs.com</RegionEndpoint>\\n <LocalName>马来西亚（吉隆坡）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-5</RegionId>\\n <RegionEndpoint>tag.ap-southeast-5.aliyuncs.com</RegionEndpoint>\\n <LocalName>印度尼西亚（雅加达）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-northeast-1</RegionId>\\n <RegionEndpoint>tag.ap-northeast-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>日本（东京）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>eu-central-1</RegionId>\\n <RegionEndpoint>tag.eu-central-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>德国（法兰克福）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>eu-west-1</RegionId>\\n <RegionEndpoint>tag.eu-west-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>英国（伦敦）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>us-west-1</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>美国（硅谷）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>us-east-1</RegionId>\\n <RegionEndpoint>tag.aliyuncs.com</RegionEndpoint>\\n <LocalName>美国（弗吉尼亚）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>me-east-1</RegionId>\\n <RegionEndpoint>tag.me-east-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>阿联酋（迪拜）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-6</RegionId>\\n <RegionEndpoint>tag.ap-southeast-6.aliyuncs.com</RegionEndpoint>\\n <LocalName>菲律宾（马尼拉）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-7</RegionId>\\n <RegionEndpoint>tag.ap-southeast-7.aliyuncs.com</RegionEndpoint>\\n <LocalName>泰国（曼谷）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-south-1</RegionId>\\n <RegionEndpoint>tag.ap-south-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>印度（孟买）</LocalName>\\n </Region>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', + 'title' => 'DescribeRegions', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreatePolicy' => [ + 'summary' => 'Creates a tag policy.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the tag policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'PolicyDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the tag policy.'."\n" + ."\n" + .'The description must be 0 to 512 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a tag policy example.', + ], + ], + [ + 'name' => 'PolicyContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'The document of the tag policy.'."\n" + ."\n" + .'For more information about the syntax of a tag policy, see [Syntax of a tag policy](~~417436~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"tags":{"CostCenter":{"tag_value":{"@@assign":["Beijing","Shanghai"]},"tag_key":{"@@assign":"CostCenter"}}}}', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* false (default): performs a dry run and performs the actual request.'."\n" + .'* true: performs only a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the Tag Policy feature. Valid values:'."\n" + ."\n" + .'* USER: single-account mode. Set the value to USER if you use an Alibaba Cloud account or a member of a resource directory to call this API operation to create a tag policy for the Alibaba Cloud account or member.'."\n" + .'* RD: multi-account mode. Set the value to RD if you use the management account of a resource directory to call this API operation to create a tag policy for the resource directory.'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FDBE270D-C491-5EEC-A5CD-98245422D3F7', + ], + 'PolicyId' => [ + 'description' => 'The ID of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'p-5732750813924f90****', + ], + 'PolicyName' => [ + 'description' => 'The name of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.RAM', + 'errorMessage' => 'The operator is not permission for the action in ram policy.', + ], + ], + 403 => [ + [ + 'errorCode' => 'EffectivePolicy.ResourceGroupScope.TooLong', + 'errorMessage' => 'The resource group range of for effective policy is too long.', + ], + [ + 'errorCode' => 'RDAcount.HasOpened', + 'errorMessage' => 'As the RD master or administrator, you cannot activate the tag policy service because account has already enabled it, you can only activate it once the policy service is disabled by the aforementioned RD account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FDBE270D-C491-5EEC-A5CD-98245422D3F7\\",\\n \\"PolicyId\\": \\"p-5732750813924f90****\\",\\n \\"PolicyName\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePolicyResponse>\\n <RequestId>FDBE270D-C491-5EEC-A5CD-98245422D3F7</RequestId>\\n <PolicyId>p-5732750813924f90****</PolicyId>\\n</CreatePolicyResponse>","errorExample":""}]', + 'title' => 'CreatePolicy', + 'description' => '###'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to create a tag policy named `test`. In this example, the Tag Policy feature in multi-account mode is used. The tag policy defines that resources to which the `CostCenter:Beijing` or `CostCenter:Shanghai` tag is added are compliant and other resources are not compliant.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'DeletePolicy' => [ + 'summary' => 'Deletes a tag policy.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the tag policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'p-557cb141331f41c7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.RAM', + 'errorMessage' => 'The operator is not permission for the action in ram policy.', + ], + ], + 403 => [ + [ + 'errorCode' => 'EffectivePolicy.ResourceGroupScope.TooLong', + 'errorMessage' => 'The resource group range of for effective policy is too long.', + ], + [ + 'errorCode' => 'RDAcount.HasOpened', + 'errorMessage' => 'As the RD master or administrator, you cannot activate the tag policy service because account has already enabled it, you can only activate it once the policy service is disabled by the aforementioned RD account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePolicyResponse>\\n <RequestId>4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A</RequestId>\\n</DeletePolicyResponse>","errorExample":""}]', + 'title' => 'DeletePolicy', + 'description' => 'Before you delete a tag policy, make sure that the tag policy is detached from all objects to which the tag policy is attached. For more information about how to detach a tag policy, see [DetachPolicy](~~429724~~).'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to delete the tag policy with an ID of `p-557cb141331f41c7****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'AttachPolicy' => [ + 'summary' => 'Attaches a tag policy to an object.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object.'."\n" + ."\n" + .'> If you use the Tag Policy feature in single-account mode, this parameter is optional. If you use the Tag Policy feature in multi-account mode, this feature is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '151266687691****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + ."\n" + .'> If you use the Tag Policy feature in single-account mode, this parameter is optional. If you use the Tag Policy feature in multi-account mode, this feature is required. The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACCOUNT', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the tag policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'p-de62a0bf400e4b69****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.RAM', + 'errorMessage' => 'The operator is not permission for the action in ram policy.', + ], + ], + 403 => [ + [ + 'errorCode' => 'EffectivePolicy.ResourceGroupScope.TooLong', + 'errorMessage' => 'The resource group range of for effective policy is too long.', + ], + [ + 'errorCode' => 'RDAcount.HasOpened', + 'errorMessage' => 'As the RD master or administrator, you cannot activate the tag policy service because account has already enabled it, you can only activate it once the policy service is disabled by the aforementioned RD account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachPolicyResponse>\\n <RequestId>4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A</RequestId>\\n</AttachPolicyResponse>","errorExample":""}]', + 'title' => 'AttachPolicy', + 'description' => 'If you use the Tag Policy feature in single-account mode, you can call this API operation to attach a tag policy to the current logon account. If you use the Tag Policy feature in multi-account mode, you can call this API operation to attach a tag policy to the Root folder, a folder other than the Root folder, or a member in a resource directory. For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to attach the tag policy with an ID of `p-de62a0bf400e4b69****` to the current logon account. In this example, the Tag Policy feature in single-account mode is used.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'DetachPolicy' => [ + 'summary' => 'Detaches a tag policy from an object.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object.'."\n" + ."\n" + .'> If you use the Tag Policy feature in single-account mode, this parameter is optional. If you use the Tag Policy feature in multi-account mode, this parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '151266687691****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + ."\n" + .'> If you use the Tag Policy feature in single-account mode, this parameter is optional. If you use the Tag Policy feature in multi-account mode, this parameter is required. The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACCOUNT', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the tag policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'p-a3381efe2fe34a75****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.RAM', + 'errorMessage' => 'The operator is not permission for the action in ram policy.', + ], + ], + 403 => [ + [ + 'errorCode' => 'EffectivePolicy.ResourceGroupScope.TooLong', + 'errorMessage' => 'The resource group range of for effective policy is too long.', + ], + [ + 'errorCode' => 'RDAcount.HasOpened', + 'errorMessage' => 'As the RD master or administrator, you cannot activate the tag policy service because account has already enabled it, you can only activate it once the policy service is disabled by the aforementioned RD account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachPolicyResponse>\\n <RequestId>4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A</RequestId>\\n</DetachPolicyResponse>","errorExample":""}]', + 'title' => 'DetachPolicy', + 'description' => '###'."\n" + ."\n" + .'If you use the Tag Policy feature in single-account mode, you can call this API operation to detach a tag policy from the current logon account. If you use the Tag Policy feature in multi-account mode, you can call this API operation to detach a tag policy from the Root folder, a folder other than the Root folder, or a member in a resource directory. For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to detach the tag policy with an ID of `p-a3381efe2fe34a75****` from the current logon account. In this example, the Tag Policy feature in single-account mode is used.'."\n", + ], + 'ModifyPolicy' => [ + 'summary' => 'Modifies a tag policy.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the tag policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'p-5732750813924f90****', + ], + ], + [ + 'name' => 'PolicyDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the tag policy.'."\n" + ."\n" + .'The description must be 0 to 512 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a tag policy example.', + ], + ], + [ + 'name' => 'PolicyContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'The document of the tag policy.'."\n" + ."\n" + .'For more information about the syntax of a tag policy, see [Syntax of a tag policy](~~417436~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"tags":{"CostCenter":{"tag_value":{"@@assign":["Beijing","Shanghai"]},"tag_key":{"@@assign":"CostCenter"}}}}', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the tag policy.'."\n" + ."\n" + .'The name must be 1 to 128 characters in length and can contain letters, digits, and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* false (default): performs a dry run and performs the actual request.'."\n" + .'* true: performs only a dry run.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.RAM', + 'errorMessage' => 'The operator is not permission for the action in ram policy.', + ], + ], + 403 => [ + [ + 'errorCode' => 'EffectivePolicy.ResourceGroupScope.TooLong', + 'errorMessage' => 'The resource group range of for effective policy is too long.', + ], + [ + 'errorCode' => 'RDAcount.HasOpened', + 'errorMessage' => 'As the RD master or administrator, you cannot activate the tag policy service because account has already enabled it, you can only activate it once the policy service is disabled by the aforementioned RD account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A32F5B0-0B0B-5537-B4A0-7A6E1C3AA96A\\"\\n}","type":"json"}]', + 'title' => 'ModifyPolicy', + 'description' => '### [](#)'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to change the name of a tag policy to `test`.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'GetPolicy' => [ + 'summary' => 'Queries the details of a tag policy.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the tag policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'p-557cb141331f41c7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1E7A4802-AB57-570A-9860-F15B60E1586B', + ], + 'Policy' => [ + 'description' => 'The details of the tag policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'PolicyName' => [ + 'description' => 'The name of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'PolicyDesc' => [ + 'description' => 'The description of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'This is a tag policy example.', + ], + 'PolicyContent' => [ + 'description' => 'The document of the tag policy.'."\n", + 'type' => 'string', + 'example' => '{\\"tags\\":{\\"CostCenter\\":{\\"tag_value\\":{\\"@@assign\\":[\\"Beijing\\",\\"Shanghai\\"]},\\"tag_key\\":{\\"@@assign\\":\\"CostCenter\\"}}}}', + ], + 'UserType' => [ + 'description' => 'The mode of the Tag Policy feature. Valid values:'."\n" + ."\n" + .'* USER: single-account mode'."\n" + .'* RD: multi-account mode'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n", + 'type' => 'string', + 'example' => 'USER', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Status', + 'errorMessage' => 'The parameter Status'."\0".' is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.Status', + 'errorMessage' => 'You must specify Status.', + ], + ], + 403 => [ + [ + 'errorCode' => 'EffectivePolicy.ResourceGroupScope.TooLong', + 'errorMessage' => 'The resource group range of for effective policy is too long.', + ], + [ + 'errorCode' => 'RDAcount.HasOpened', + 'errorMessage' => 'As the RD master or administrator, you cannot activate the tag policy service because account has already enabled it, you can only activate it once the policy service is disabled by the aforementioned RD account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E7A4802-AB57-570A-9860-F15B60E1586B\\",\\n \\"Policy\\": {\\n \\"PolicyName\\": \\"test\\",\\n \\"PolicyDesc\\": \\"This is a tag policy example.\\",\\n \\"PolicyContent\\": \\"{\\\\\\\\\\\\\\"tags\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"CostCenter\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"tag_value\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"@@assign\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Shanghai\\\\\\\\\\\\\\"]},\\\\\\\\\\\\\\"tag_key\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"@@assign\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CostCenter\\\\\\\\\\\\\\"}}}}\\",\\n \\"UserType\\": \\"USER\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPolicyResponse>\\n <Policy>\\n <PolicyDesc>This is a tag policy example.</PolicyDesc>\\n <PolicyName>test</PolicyName>\\n <UserType>USER</UserType>\\n <PolicyContent>{\\"tags\\":{\\"CostCenter\\":{\\"tag_value\\":{\\"@@assign\\":[\\"Beijing\\",\\"Shanghai\\"]},\\"tag_key\\":{\\"@@assign\\":\\"CostCenter\\"}}}}</PolicyContent>\\n </Policy>\\n <RequestId>1E7A4802-AB57-570A-9860-F15B60E1586B</RequestId>\\n</GetPolicyResponse>","errorExample":""}]', + 'title' => 'GetPolicy', + 'description' => 'This topic provides an example on how to call the API operation to query the details of the tag policy with an ID of `p-557cb141331f41c7****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'GetPolicyEnableStatus' => [ + 'summary' => 'Queries the status of the Tag Policy feature.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the Tag Policy feature. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* USER: single-account mode'."\n" + .'* RD: multi-account mode'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RD', + ], + ], + [ + 'name' => 'OpenType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The enabling type. Valid values:'."\n" + ."\n" + .'* TAG_POLICY: the Tag Policy feature.'."\n" + .'* VERIFY_NO_TAG: the strong verification feature.'."\n" + .'* TAG_POLICY_NOTIFY: the notification feature that sends notifications for resources found to be non-compliant with the tag policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TAG_POLICY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6C8DF1B1-C65F-5D3A-9FDA-26A4683BB36B', + ], + 'StatusModels' => [ + 'description' => 'The information of the Tag Policy feature.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the Tag Policy feature.', + 'type' => 'object', + 'properties' => [ + 'UserType' => [ + 'description' => 'The mode of the Tag Policy feature. Valid values:'."\n" + ."\n" + .'* USER: single-account mode'."\n" + .'* RD: multi-account mode'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n", + 'type' => 'string', + 'example' => 'RD', + ], + 'Status' => [ + 'description' => 'The status of the Tag Policy feature. Valid values:'."\n" + ."\n" + .'* PendingEnable: The feature is being enabled.'."\n" + .'* Enabled: The feature is enabled.'."\n" + .'* Closing: The feature is being disabled.'."\n" + .'* Disabled: The feature is disabled.'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6C8DF1B1-C65F-5D3A-9FDA-26A4683BB36B\\",\\n \\"StatusModels\\": [\\n {\\n \\"UserType\\": \\"RD\\",\\n \\"Status\\": \\"Enabled\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetPolicyEnableStatusResponse>\\n <RequestId>6C8DF1B1-C65F-5D3A-9FDA-26A4683BB36B</RequestId>\\n <StatusModels>\\n <Status>Enabled</Status>\\n <UserType>RD</UserType>\\n </StatusModels>\\n</GetPolicyEnableStatusResponse>","errorExample":""}]', + 'title' => 'GetPolicyEnableStatus', + 'description' => 'This topic provides an example on how to call the API operation to query the status of the Tag Policy feature for the current logon account. The response shows that the Tag Policy feature in multi-account mode is enabled for the current logon account.', + ], + 'ListPolicies' => [ + 'summary' => 'Queries a list of tag policies.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 50. Maximum value: 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of a tag policy. This parameter specifies a filter condition for the query.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a tag policy. This parameter specifies a filter condition for the query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'p-557cb141331f41c7****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'PolicyNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The name of a tag policy. This parameter specifies a filter condition for the query.', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of a tag policy. This parameter specifies a filter condition for the query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the Tag Policy feature. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* USER: single-account mode'."\n" + .'* RD: multi-account mode'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'USER', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '72477CFF-5B24-5E30-9861-3DD9C4BD46E5', + ], + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'PolicyList' => [ + 'description' => 'The tag policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag policies.', + 'type' => 'object', + 'properties' => [ + 'PolicyName' => [ + 'description' => 'The name of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + 'PolicyDesc' => [ + 'description' => 'The description of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'This is a tag policy example.', + ], + 'PolicyContent' => [ + 'description' => 'The document of the tag policy.'."\n", + 'type' => 'string', + 'example' => '{\\"tags\\":{\\"CostCenter\\":{\\"tag_value\\":{\\"@@assign\\":[\\"Beijing\\",\\"Shanghai\\"]},\\"tag_key\\":{\\"@@assign\\":\\"CostCenter\\"}}}}', + ], + 'PolicyId' => [ + 'description' => 'The ID of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'p-de62a0bf400e4b69****', + ], + 'UserType' => [ + 'description' => 'The mode of the Tag Policy feature. Valid values:'."\n" + ."\n" + .'* USER: single-account mode'."\n" + .'* RD: multi-account mode'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n", + 'type' => 'string', + 'example' => 'USER', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"72477CFF-5B24-5E30-9861-3DD9C4BD46E5\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"PolicyList\\": [\\n {\\n \\"PolicyName\\": \\"example\\",\\n \\"PolicyDesc\\": \\"This is a tag policy example.\\",\\n \\"PolicyContent\\": \\"{\\\\\\\\\\\\\\"tags\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"CostCenter\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"tag_value\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"@@assign\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Shanghai\\\\\\\\\\\\\\"]},\\\\\\\\\\\\\\"tag_key\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"@@assign\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CostCenter\\\\\\\\\\\\\\"}}}}\\",\\n \\"PolicyId\\": \\"p-de62a0bf400e4b69****\\",\\n \\"UserType\\": \\"USER\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPoliciesResponse>\\n <RequestId>72477CFF-5B24-5E30-9861-3DD9C4BD46E5</RequestId>\\n <PolicyList>\\n <PolicyDesc>This is a tag policy example.</PolicyDesc>\\n <PolicyName>example</PolicyName>\\n <UserType>USER</UserType>\\n <PolicyId>p-de62a0bf400e4b69****</PolicyId>\\n <PolicyContent>{\\"tags\\":{\\"CostCenter\\":{\\"tag_value\\":{\\"@@assign\\":[\\"Beijing\\",\\"Shanghai\\"]},\\"tag_key\\":{\\"@@assign\\":\\"CostCenter\\"}}}}</PolicyContent>\\n </PolicyList>\\n <PolicyList>\\n <PolicyDesc>This is a tag policy example.</PolicyDesc>\\n <PolicyName>test</PolicyName>\\n <UserType>USER</UserType>\\n <PolicyId>p-557cb141331f41c7****</PolicyId>\\n <PolicyContent>{\\"tags\\":{\\"k1\\":{\\"tag_value\\":{\\"@@assign\\":[\\"v1\\"]},\\"tag_key\\":{\\"@@assign\\":\\"k1\\"}}}}</PolicyContent>\\n </PolicyList>\\n</ListPoliciesResponse>","errorExample":""}]', + 'title' => 'ListPolicies', + 'description' => 'If you use the Tag Policy feature in single-account mode, you can use the current logon account to call this API operation to query all tag policies that are created for the account. If you use the Tag Policy feature in multi-account mode, you can use the management account of a resource directory to call this API operation to query all tag policies that are created for the resource directory. For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query all tag policies that are created for the current logon account. In this example, the Tag Policy feature in single-account mode is used. The response shows that two tag policies are created.', + ], + 'ListPoliciesForTarget' => [ + 'summary' => 'Queries a list of tag policies that are attached to an object.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 50. Maximum value: 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object. This parameter specifies a filter condition for the query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '154950938137****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACCOUNT', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResponse<PolicyModel>', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The tag policies that are attached to the object.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag policies that are attached to the object.', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => 'The ID of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'p-de62a0bf400e4b69****', + ], + 'PolicyName' => [ + 'description' => 'The name of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'example', + ], + 'PolicyDesc' => [ + 'description' => 'The description of the tag policy.'."\n", + 'type' => 'string', + 'example' => 'This is a tag policy example.', + ], + 'PolicyContent' => [ + 'description' => 'The document of the tag policy.'."\n", + 'type' => 'string', + 'example' => '{\\"tags\\":{\\"CostCenter\\":{\\"tag_value\\":{\\"@@assign\\":[\\"Beijing\\",\\"Shanghai\\"]},\\"tag_key\\":{\\"@@assign\\":\\"CostCenter\\"}}}}', + ], + 'UserType' => [ + 'description' => 'The mode of the Tag Policy feature. Valid values:'."\n" + ."\n" + .'* USER: single-account mode'."\n" + .'* RD: multi-account mode'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n", + 'type' => 'string', + 'example' => 'USER', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8C962146-AB38-516C-818C-695D4E9F2EA2', + ], + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": [\\n {\\n \\"PolicyId\\": \\"p-de62a0bf400e4b69****\\",\\n \\"PolicyName\\": \\"example\\",\\n \\"PolicyDesc\\": \\"This is a tag policy example.\\",\\n \\"PolicyContent\\": \\"{\\\\\\\\\\\\\\"tags\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"CostCenter\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"tag_value\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"@@assign\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Shanghai\\\\\\\\\\\\\\"]},\\\\\\\\\\\\\\"tag_key\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"@@assign\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CostCenter\\\\\\\\\\\\\\"}}}}\\",\\n \\"UserType\\": \\"USER\\"\\n }\\n ],\\n \\"RequestId\\": \\"8C962146-AB38-516C-818C-695D4E9F2EA2\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\"\\n}","errorExample":""},{"type":"xml","example":"<ListPoliciesForTargetResponse>\\n <RequestId>8C962146-AB38-516C-818C-695D4E9F2EA2</RequestId>\\n <Data>\\n <PolicyDesc>This is a tag policy example.</PolicyDesc>\\n <PolicyName>example</PolicyName>\\n <UserType>USER</UserType>\\n <PolicyId>p-de62a0bf400e4b69****</PolicyId>\\n <PolicyContent>{\\"tags\\":{\\"CostCenter\\":{\\"tag_value\\":{\\"@@assign\\":[\\"Beijing\\",\\"Shanghai\\"]},\\"tag_key\\":{\\"@@assign\\":\\"CostCenter\\"}}}}</PolicyContent>\\n </Data>\\n</ListPoliciesForTargetResponse>","errorExample":""}]', + 'title' => 'ListPoliciesForTarget', + 'description' => 'If you use the Tag Policy feature in single-account mode, you can use the current logon account to call this API operation to query the tag policies that are attached to the account. If you use the Tag Policy feature in multi-account mode, you can use the management account of a resource directory to call this API operation to query the tag policies that are attached to the Root folder, a folder other than the Root folder, or a member in the resource directory. For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query the tag policies that are attached to the current logon account. In this example, the Tag Policy feature in single-account mode is used. The response shows that only one tag policy is attached to the current logon account.', + ], + 'GetEffectivePolicy' => [ + 'summary' => 'Queries effective policies.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object.'."\n" + ."\n" + .'> If you use the Tag Policy feature in single-account mode, this parameter is optional. If you use the Tag Policy feature in multi-account mode, this feature is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '154950938137****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + ."\n" + .'> If you use the Tag Policy feature in single-account mode, this parameter is optional. If you use the Tag Policy feature in multi-account mode, this feature is required. The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACCOUNT', + ], + ], + [ + 'name' => 'TagKeys', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BB532282-94F5-5F56-877F-32D5E2A04F3F', + ], + 'EffectivePolicy' => [ + 'description' => 'The effective tag policy.'."\n", + 'type' => 'string', + 'example' => '{\\"tags\\":{\\"costcenter\\":{\\"tag_value\\":[\\"Beijing\\",\\"Shanghai\\"],\\"tag_key\\":\\"CostCenter\\"}}}', + ], + 'PolicyAttachments' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'type' => 'string', + ], + 'PolicyType' => [ + 'type' => 'string', + ], + 'PolicyList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'type' => 'string', + ], + 'PolicyName' => [ + 'type' => 'string', + ], + 'AttachSeq' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AttachTime' => [ + 'type' => 'string', + ], + 'TargetId' => [ + 'type' => 'string', + ], + 'TargetType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.RAM', + 'errorMessage' => 'The operator is not permission for the action in ram policy.', + ], + ], + 403 => [ + [ + 'errorCode' => 'EffectivePolicy.ResourceGroupScope.TooLong', + 'errorMessage' => 'The resource group range of for effective policy is too long.', + ], + [ + 'errorCode' => 'ConfigRule.NotExist', + 'errorMessage' => 'Config rule id does not exist.', + ], + [ + 'errorCode' => 'RDAcount.HasOpened', + 'errorMessage' => 'As the RD master or administrator, you cannot activate the tag policy service because account has already enabled it, you can only activate it once the policy service is disabled by the aforementioned RD account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BB532282-94F5-5F56-877F-32D5E2A04F3F\\",\\n \\"EffectivePolicy\\": \\"{\\\\\\\\\\\\\\"tags\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"costcenter\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"tag_value\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Shanghai\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"tag_key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CostCenter\\\\\\\\\\\\\\"}}}\\",\\n \\"PolicyAttachments\\": [\\n {\\n \\"TagKey\\": \\"\\",\\n \\"PolicyType\\": \\"\\",\\n \\"PolicyList\\": [\\n {\\n \\"PolicyId\\": \\"\\",\\n \\"PolicyName\\": \\"\\",\\n \\"AttachSeq\\": 0,\\n \\"AttachTime\\": \\"\\",\\n \\"TargetId\\": \\"\\",\\n \\"TargetType\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetEffectivePolicyResponse>\\n <EffectivePolicy>{\\"tags\\":{\\"costcenter\\":{\\"tag_value\\":[\\"Beijing\\",\\"Shanghai\\"],\\"tag_key\\":\\"CostCenter\\"}}}</EffectivePolicy>\\n <RequestId>BB532282-94F5-5F56-877F-32D5E2A04F3F</RequestId>\\n</GetEffectivePolicyResponse>","errorExample":""}]', + 'title' => 'GetEffectivePolicy', + 'description' => 'If you use the Tag Policy feature in single-account mode, you can use the current logon account to call this API operation to query the effective tag policy for the account. If you use the Tag Policy feature in multi-account mode, you can use the management account of a resource directory to call this API operation to query the effective tag policy for the Root folder, a folder other than the Root folder, or a member in the resource directory. You can also use a member of a resource directory to call this API operation to query the effective tag policy for the member. For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'An effective tag policy is obtained based on tag policy inheritance. For more information, see [Inheritance of a tag policy and calculation of an effective tag policy](~~417435~~).'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query the effective tag policy for the current logon account. In this example, the Tag Policy feature in single-account mode is used.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'ListTargetsForPolicy' => [ + 'summary' => 'Queries the objects to which a tag policy is attached.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 50. Maximum value: 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the tag policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'p-de62a0bf400e4b69****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<ListTargetsModel>', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Targets' => [ + 'description' => 'The objects to which the tag policy is attached.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The objects to which the tag policy is attached.', + 'type' => 'object', + 'properties' => [ + 'TargetId' => [ + 'description' => 'The ID of the object.'."\n", + 'type' => 'string', + 'example' => '195320939469****', + ], + 'TargetType' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'ACCOUNT', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2EE71C8D-6DB8-56AC-8B05-3D4C0116E6A1', + ], + 'IsRd' => [ + 'description' => 'Indicates whether the object belongs to the resource directory. Valid values:'."\n" + ."\n" + .'* true: The object belongs to the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* false: The object does not belong to the resource directory. This value is available if you use the Tag Policy feature in single-account mode.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RdId' => [ + 'description' => 'The ID of the resource directory.'."\n" + ."\n" + .'> This parameter is returned only if you use the Tag Policy feature in multi-account mode.'."\n", + 'type' => 'string', + 'example' => 'rd-3G****', + ], + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Targets\\": [\\n {\\n \\"TargetId\\": \\"195320939469****\\",\\n \\"TargetType\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"2EE71C8D-6DB8-56AC-8B05-3D4C0116E6A1\\",\\n \\"IsRd\\": true,\\n \\"RdId\\": \\"rd-3G****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\"\\n}","errorExample":""},{"type":"xml","example":"<ListTargetsForPolicyResponse>\\n\\t<RequestId>B90479D5-CB51-5BA8-A13F-989A81B81273</RequestId>\\n\\t<Targets>\\n\\t\\t<Target>\\n\\t\\t\\t<TargetType>ACCOUNT</TargetType>\\n\\t\\t\\t<TargetId>195320939469****</TargetId>\\n\\t\\t</Target>\\n\\t\\t<Target>\\n\\t\\t\\t<TargetType>ACCOUNT</TargetType>\\n\\t\\t\\t<TargetId>177242285274****</TargetId>\\n\\t\\t</Target>\\n\\t</Targets>\\n\\t<RdId>rd-3G****</RdId>\\n\\t<IsRd>true</IsRd>\\n</ListTargetsForPolicyResponse>\\t\\n","errorExample":""}]', + 'title' => 'ListTargetsForPolicy', + 'description' => 'If you use the Tag Policy feature in single-account mode, you can use the current logon account to call this API operation to query the object to which a tag policy is attached. The object is the current logon account. If you use the Tag Policy feature in multi-account mode, you can use the management account of a resource directory to call this API operation to query the objects to which a tag policy is attached. The objects include the Root folder, folders other than the Root folder, and members in the resource directory. For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query the objects to which the tag policy with an ID of `p-de62a0bf400e4b69****` is attached. In this example, the Tag Policy feature in multi-account mode is used. The response shows that the tag policy is attached to two members in the related resource directory.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'ListConfigRulesForTarget' => [ + 'summary' => 'Queries a list of tag detection tasks for an object.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object. This parameter specifies a filter condition for the query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '134254031178****', + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 50. Maximum value: 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key. This parameter specifies a filter condition for the query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CostCenter', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACCOUNT', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The use scenario of the tag policy. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* tags: enables tags with specified tag values to be added to resources.'."\n" + .'* rg_inherit: enables resources in a resource group to automatically inherit tags from the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tags', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the Tag Policy feature. This parameter specifies a filter condition for the query. Valid values:'."\n" + ."\n" + .'* USER: single-account mode'."\n" + .'* RD: multi-account mode'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'USER', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResponse<PolicyModel>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The tag detection tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag detection tasks.', + 'type' => 'object', + 'properties' => [ + 'TargetId' => [ + 'description' => 'The ID of the object.'."\n", + 'type' => 'string', + 'example' => '134254031178****', + ], + 'TargetType' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n", + 'type' => 'string', + 'example' => 'USER', + ], + 'ConfigRuleId' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'string', + 'example' => 'cr-0lb4866180880069****', + ], + 'AggregatorId' => [ + 'description' => 'The ID of the account group.'."\n" + ."\n" + .'You can use the ID to query the content of the related resource non-compliance report in Cloud Config.'."\n" + ."\n" + .'> This parameter is returned only if you use the Tag Policy feature in multi-account mode.'."\n", + 'type' => 'string', + 'example' => 'ca-efdc33dc9b37002d****', + ], + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'CostCenter', + ], + 'Remediation' => [ + 'description' => 'Indicates whether automatic remediation is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'PolicyType' => [ + 'description' => 'The use scenario of the tag policy. Valid values:'."\n" + ."\n" + .'* tags: enables tags with specified tag values to be added to resources.'."\n" + .'* rg_inherit: enables resources in a resource group to automatically inherit tags from the resource group.'."\n", + 'type' => 'string', + 'example' => 'tags', + ], + 'TagValue' => [ + 'description' => 'The tag value for automatic remediation.'."\n", + 'type' => 'string', + 'example' => 'Project', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7126AECD-D7AD-5073-8E88-DD2BD1FC139E', + ], + 'NextToken' => [ + 'description' => 'Indicates whether the next query is required.'."\n" + ."\n" + .'* If the value of this parameter is empty (`"NextToken": ""`), all results are returned, and the next query is not required.'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": [\\n {\\n \\"TargetId\\": \\"134254031178****\\",\\n \\"TargetType\\": \\"USER\\",\\n \\"ConfigRuleId\\": \\"cr-0lb4866180880069****\\",\\n \\"AggregatorId\\": \\"ca-efdc33dc9b37002d****\\",\\n \\"TagKey\\": \\"CostCenter\\",\\n \\"Remediation\\": false,\\n \\"PolicyType\\": \\"tags\\",\\n \\"TagValue\\": \\"Project\\"\\n }\\n ],\\n \\"RequestId\\": \\"7126AECD-D7AD-5073-8E88-DD2BD1FC139E\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\"\\n}","errorExample":""},{"type":"xml","example":"<ListConfigRulesForTargetResponse>\\n <RequestId>7126AECD-D7AD-5073-8E88-DD2BD1FC139E</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <ConfigRuleId>cr-0lb4866180880069****</ConfigRuleId>\\n <PolicyType>tags</PolicyType>\\n <TargetType>USER</TargetType>\\n <TagKey>CostCenter</TagKey>\\n <Remediation>false</Remediation>\\n <TargetId>134254031178****</TargetId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListConfigRulesForTargetResponse>","errorExample":""}]', + 'title' => 'ListConfigRulesForTarget', + 'description' => 'If you use the Tag Policy feature in single-account mode, you can use the current logon account to call this API operation to query the tag detection tasks for the account. If you use the Tag Policy feature in multi-account mode, you can use the management account of a resource directory to call this API operation to query the tag detection tasks for the Root folder, a folder other than the Root folder, or a member in the resource directory. For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'This topic provides an example on how to call the API operation to query the tag detection tasks for the current logon account. In this example, the Tag Policy feature in single-account mode is used. The response shows that only one tag detection task exists.', + ], + 'GetConfigRuleReport' => [ + 'summary' => 'Queries the basic information about the latest resource non-compliance report.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '154950938137****', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the Tag Policy feature. Valid values:'."\n" + ."\n" + .'* USER: single-account mode'."\n" + .'* RD: multi-account mode'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'USER', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'USER', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResponse<PolicyModel>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A68BD5BC-5B12-5A9B-8AE9-77884886BE10', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* true: The request is successful.'."\n" + .'* false: The request fails.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The basic information of the resource non-compliance report that is last generated.'."\n", + 'type' => 'object', + 'properties' => [ + 'ReportId' => [ + 'description' => 'The ID of the report.'."\n", + 'type' => 'string', + 'example' => 'crp-ao0786618088006c****', + ], + 'CreatedTime' => [ + 'description' => 'The time when the report was generated. This value is a UNIX timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655089159000', + ], + 'TargetId' => [ + 'description' => 'The ID of the object.'."\n" + ."\n" + .'> This parameter is returned if you set the `TargetType` and `TargetId` parameters in the current request to the same values as the parameters that are configured when you call the [GenerateConfigRuleReport](~~433313~~) operation to generate the report.'."\n", + 'type' => 'string', + 'example' => '154950938137****', + ], + 'TargetType' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + ."\n" + .'> This parameter is returned if you set the `TargetType` and `TargetId` parameters in the current request to the same values as the parameters that are configured when you call the [GenerateConfigRuleReport](~~433313~~) operation to generate the report.'."\n", + 'type' => 'string', + 'example' => 'ACCOUNT', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A68BD5BC-5B12-5A9B-8AE9-77884886BE10\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"ReportId\\": \\"crp-ao0786618088006c****\\",\\n \\"CreatedTime\\": 1655089159000,\\n \\"TargetId\\": \\"154950938137****\\",\\n \\"TargetType\\": \\"ACCOUNT\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetConfigRuleReportResponse>\\n <RequestId>A68BD5BC-5B12-5A9B-8AE9-77884886BE10</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <CreatedTime>1655089159000</CreatedTime>\\n <ReportId>crp-ao0786618088006c****</ReportId>\\n </Data>\\n <Success>true</Success>\\n</GetConfigRuleReportResponse>","errorExample":""}]', + 'title' => 'GetConfigRuleReport', + 'description' => 'If you use the Tag Policy feature in single-account mode, you can use the current logon account to call this API operation to query the basic information of the resource non-compliance report that is last generated for the account. If you use the Tag Policy feature in multi-account mode, you can use the management account of a resource directory to call this API operation to query the basic information of the resource non-compliance report that is last generated for an object in the resource directory. The object can be the Root folder, a folder other than the Root folder, or a member. For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'This topic provides an example on how to call this API operation to query the basic information of the resource non-compliance report that is last generated for the current logon account. In this example, the Tag Policy feature in single-account mode is used. The response shows that the ID of the report is `crp-ao0786618088006c****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'GenerateConfigRuleReport' => [ + 'summary' => 'Generates a resource non-compliance report.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to cn-shanghai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the object.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '154950938137****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.'."\n" + .'* ROOT: the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* FOLDER: a folder other than the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + .'* ACCOUNT: a member in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.'."\n" + ."\n" + .'> The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACCOUNT', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the Tag Policy feature. Valid values:'."\n" + ."\n" + .'* USER: single-account mode'."\n" + .'* RD: multi-account mode'."\n" + ."\n" + .'For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'> This parameter is required if the management account of your resource directory is used to enable the Tag Policy feature in both single-account mode and multi-account mode. The value of this parameter is not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'USER', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResponse<PolicyModel>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '37B2AC06-89D8-5D95-98DF-3E68C12BDE05', + ], + 'ReportId' => [ + 'description' => 'The ID of the resource non-compliance report.'."\n", + 'type' => 'string', + 'example' => 'crp-ao0786618088006c****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GlobalAggregator.NotFount', + 'errorMessage' => 'Can not find global aggregator', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission.Operator ', + 'errorMessage' => 'Only the RD admin account has permission to operate', + ], + [ + 'errorCode' => 'TagPolicy.NotOpen', + 'errorMessage' => 'You have not activated the tag policy service.', + ], + [ + 'errorCode' => 'TagPolicy.PendingEnable', + 'errorMessage' => 'The tag policy status is pending enable.', + ], + [ + 'errorCode' => 'WrongEndpoint', + 'errorMessage' => 'Only the shanghai endpoint supports the operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"37B2AC06-89D8-5D95-98DF-3E68C12BDE05\\",\\n \\"ReportId\\": \\"crp-ao0786618088006c****\\"\\n}","errorExample":""},{"type":"xml","example":"<GenerateConfigRuleReportResponse>\\n <RequestId>37B2AC06-89D8-5D95-98DF-3E68C12BDE05</RequestId>\\n <ReportId>crp-ao0786618088006c****</ReportId>\\n</GenerateConfigRuleReportResponse>","errorExample":""}]', + 'title' => 'GenerateConfigRuleReport', + 'description' => 'If you use the Tag Policy feature in single-account mode, you can call this API operation to generate a resource non-compliance report for the current logon account. If you use the Tag Policy feature in multi-account mode, you can call this API operation to generate a resource non-compliance report for the Root folder, a folder other than the Root folder, or a member in a resource directory. For more information about the modes of the Tag Policy feature, see [Modes of the Tag Policy feature](~~417434~~).'."\n" + ."\n" + .'This topic provides an example on how to call this API operation to generate a resource non-compliance report for the current logon account. In this example, the Tag Policy feature in single-account mode is used.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~159973~~).'."\n", + ], + 'CreateAssociatedResourceRules' => [ + 'summary' => 'Creates associated resource tagging rules.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CreateRulesList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The associated resource tagging rules that you want to create.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The associated resource tagging rule that you want to create.'."\n", + 'type' => 'object', + 'properties' => [ + 'SettingName' => [ + 'description' => 'The name of the associated resource tagging rule.'."\n" + ."\n" + .'For more information, see the **Rule Name** column in [Resource types that support the Associated Resource Tagging feature](~~2586330~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rule:AttachEni-DetachEni-TagInstance:Ecs-Instance:Ecs-Eni', + ], + 'Status' => [ + 'description' => 'Specifies whether to enable the associated resource tagging rule. Valid values:'."\n" + ."\n" + .'* Enable (default)'."\n" + .'* Disable'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Enable', + ], + 'TagKeys' => [ + 'description' => 'The tag keys to which the associated resource tagging rule applies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key to which the associated resource tagging rule applies.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ExistingStatus' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '33BD6957-D7B0-500C-ADA1-300414EDCE89', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOperation.NotActivated', + 'errorMessage' => 'The associated resources service has not been activated.', + ], + [ + 'errorCode' => 'MissingParameter.SettingName', + 'errorMessage' => 'You must specify SettingName.', + ], + [ + 'errorCode' => 'InvalidParameter.SettingName', + 'errorMessage' => 'The parameter SettingName is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.AssociatedResourceRule', + 'errorMessage' => 'The parameter AssociatedResourceRule must not be null.', + ], + [ + 'errorCode' => 'MissingParameter.Status', + 'errorMessage' => 'You must specify Status.', + ], + [ + 'errorCode' => 'InvalidParameter.Status', + 'errorMessage' => 'The parameter Status is invalid.', + ], + [ + 'errorCode' => 'NumberExceed.TagKeys', + 'errorMessage' => 'The maximum number of TagKeys is exceeded.', + ], + [ + 'errorCode' => 'Invalid.SettingName', + 'errorMessage' => 'The parameter SettingName is invalid.', + ], + [ + 'errorCode' => 'InvalidRule.Existed', + 'errorMessage' => 'The rule with SettingName already exists, please do not create it again.', + ], + [ + 'errorCode' => 'InvalidSettingName.NotFound', + 'errorMessage' => 'The specified Setting Name is not found.', + ], + [ + 'errorCode' => 'NumberExceed.SettingNames', + 'errorMessage' => 'The maximum number of SettingNames is exceeded.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'No access permission, please contact the master account or permission administrator for authorization.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"33BD6957-D7B0-500C-ADA1-300414EDCE89\\"\\n}","type":"json"}]', + 'title' => 'CreateAssociatedResourceRules', + 'translator' => 'machine', + ], + 'UpdateAssociatedResourceRule' => [ + 'summary' => 'Update the rule for tagging associated resources.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SettingName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The setting name of the associated resource tag rule.'."\n" + ."\n" + .'For specific values, see the **Rule Setting Name** column in [Resources that Support Associated Resource Tag Settings](~~2586330~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'rule:AssociateEip-UnassociateEip-TagInstance:Ecs-Instance:Vpc-Eip', + ], + ], + [ + 'name' => 'TagKeys', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of tag keys affected by the associated resource tag rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag key affected by the associated resource tag rule.', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether to enable the associated resource tag rule. Values:'."\n" + ."\n" + .'- Enable: Enabled.'."\n" + .'- Disable: Disabled.', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + ], + ], + [ + 'name' => 'ExistingStatus', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '94E16BB6-3FB6-1297-B5B2-ED2250F437CD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOperation.NotActivated', + 'errorMessage' => 'The associated resources service has not been activated.', + ], + [ + 'errorCode' => 'MissingParameter.SettingName', + 'errorMessage' => 'You must specify SettingName.', + ], + [ + 'errorCode' => 'NumberExceed.TagKeys', + 'errorMessage' => 'The maximum number of TagKeys is exceeded.', + ], + [ + 'errorCode' => 'InvalidParameter.Status', + 'errorMessage' => 'The parameter Status is invalid.', + ], + [ + 'errorCode' => 'InvalidSettingName.NotFound', + 'errorMessage' => 'The specified SettingName is not found.', + ], + [ + 'errorCode' => 'Invalid.SettingName', + 'errorMessage' => 'The parameter SettingName is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'No access permission, please contact the master account or permission administrator for authorization.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94E16BB6-3FB6-1297-B5B2-ED2250F437CD\\"\\n}","type":"json"}]', + 'title' => 'UpdateAssociatedResourceRule', + 'translator' => 'machine', + ], + 'ListAssociatedResourceRules' => [ + 'summary' => 'Search the rules for associated resources that the user has set up.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Token for the next query start.', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of data entries to display per page during pagination.'."\n" + ."\n" + .'Default value: 50. Maximum value: 100.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'SettingName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Setting name of the associated resource tag rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'Setting name of the associated resource tag rule.', + 'type' => 'string', + 'required' => false, + 'example' => 'rule:UpdateLoadBalancerZones-UpdateLoadBalancerAddressTypeConfig-TagAlb:Alb-LoadBalancer:Vpc-Eip', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether the associated resource tag rule is enabled. Values:'."\n" + ."\n" + .'- Enable: Enabled.'."\n" + .'- Disable: Disabled.', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '6E27F22C-EDA3-132E-A53F-77DE3BC2343D', + ], + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空或者空字符串代表数据已经读取完毕', + 'description' => 'Determine if there is a token for the next query based on `NextToken`. Values:'."\n" + ."\n" + .'- If `NextToken` is empty, it indicates there is no next query.'."\n" + .'- If `NextToken` has a value, that value is the token for the next query start.', + 'type' => 'string', + 'required' => true, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'Rules' => [ + 'description' => 'List of associated resource tag rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'Associated resource tag rule.', + 'type' => 'object', + 'properties' => [ + 'SettingName' => [ + 'description' => 'Setting name of the associated resource tag rule.', + 'type' => 'string', + 'example' => 'rule:UpdateLoadBalancerZones-UpdateLoadBalancerAddressTypeConfig-TagAlb:Alb-LoadBalancer:Vpc-Eip', + ], + 'Status' => [ + 'description' => 'Whether the associated resource tag rule is enabled. Values:'."\n" + ."\n" + .'- Enable: Enabled.'."\n" + .'- Disable: Disabled.', + 'type' => 'string', + 'example' => 'Disable/Enable', + ], + 'TagKeys' => [ + 'description' => 'List of tag keys for the associated resource tag rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag key.', + 'type' => 'string', + 'example' => 'k1', + ], + ], + 'ExistingStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOperation.NotActivated', + 'errorMessage' => 'The associated resources service has not been activated.', + ], + [ + 'errorCode' => 'InvalidParameter.Status', + 'errorMessage' => 'The parameter Status is invalid.', + ], + [ + 'errorCode' => 'NumberExceed.SettingNames', + 'errorMessage' => 'The maximum number of SettingNames is exceeded.', + ], + [ + 'errorCode' => 'Invalid.SettingName', + 'errorMessage' => 'The parameter SettingName is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'No access permission, please contact the master account or permission administrator for authorization.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6E27F22C-EDA3-132E-A53F-77DE3BC2343D\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"Rules\\": [\\n {\\n \\"SettingName\\": \\"rule:UpdateLoadBalancerZones-UpdateLoadBalancerAddressTypeConfig-TagAlb:Alb-LoadBalancer:Vpc-Eip\\",\\n \\"Status\\": \\"Disable/Enable\\",\\n \\"TagKeys\\": [\\n \\"k1\\"\\n ],\\n \\"ExistingStatus\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListAssociatedResourceRules', + 'translator' => 'machine', + ], + 'DeleteAssociatedResourceRule' => [ + 'summary' => 'Deletes an associated resource tagging rule.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SettingName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the associated resource tagging rule.'."\n" + ."\n" + .'For more information, see the **Rule Name** column in [Resource types that support the Associated Resource Tagging feature](~~2586330~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rule:AttachEni-DetachEni-TagInstance:Ecs-Instance:Ecs-Eni', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BB532282-94F5-5F56-877F-32D5E2A04F3F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOperation.NotActivated', + 'errorMessage' => 'The associated resources service has not been activated.', + ], + [ + 'errorCode' => 'MissingParameter.SettingName', + 'errorMessage' => 'You must specify SettingName.', + ], + [ + 'errorCode' => 'InvalidSettingName.NotFound', + 'errorMessage' => 'The specified SettingName is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'No access permission, please contact the master account or permission administrator for authorization.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB532282-94F5-5F56-877F-32D5E2A04F3F\\"\\n}","type":"json"}]', + 'title' => 'DeleteAssociatedResourceRule', + 'translator' => 'machine', + ], + 'DisablePolicyType' => [ + 'summary' => 'Disable the Tag Policy feature.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OpenType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6E27F22C-EDA3-132E-A53F-77DE3BC2343D', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E27F22C-EDA3-132E-A53F-77DE3BC2343D\\"\\n}","errorExample":""},{"type":"xml","example":"<DisablePolicyTypeResponse>\\n <RequestId>6E27F22C-EDA3-132E-A53F-77DE3BC2343D</RequestId>\\n</DisablePolicyTypeResponse>","errorExample":""}]', + 'title' => 'DisablePolicyType', + 'requestParamsDescription' => '[](~~159973~~)'."\n", + ], + 'EnablePolicyType' => [ + 'summary' => '开通策略', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OpenType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6E27F22C-EDA3-132E-A53F-77DE3BC2343D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOperation.NotActivated', + 'errorMessage' => 'The associated resources service has not been activated.', + ], + ], + 403 => [ + [ + 'errorCode' => 'RDAcount.HasOpened', + 'errorMessage' => 'As the RD master or administrator, you cannot activate the tag policy service because account has already enabled it, you can only activate it once the policy service is disabled by the aforementioned RD account.', + ], + [ + 'errorCode' => 'NoPermission.Operator', + 'errorMessage' => 'The operator has no permission for this operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E27F22C-EDA3-132E-A53F-77DE3BC2343D\\"\\n}","errorExample":""},{"type":"xml","example":"<EnablePolicyTypeResponse>\\n <RequestId>6E27F22C-EDA3-132E-A53F-77DE3BC2343D</RequestId>\\n</EnablePolicyTypeResponse>","errorExample":""}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'tag.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'tag.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'tag.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'tag.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'tag.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'tag.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'tag.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'tag.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'tag.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'tag.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'tag.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'tag.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'tag.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'tag.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'tag.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'tag.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'tag.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'tag.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'tag.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'tag.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'tag.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'tag.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'tag.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'tag.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'tag.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'tag.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'tag.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'tag.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'tag.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'tag.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'tag.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'tag.me-central-1.aliyuncs.com', + ], + ], +]; |