Queries tag keys.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vpc:DescribeTagKeys | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ResourceType | string | No | The resource type. Valid values:
| VPC |
Keyword | string | No | The tag keys. | keyword |
RegionId | string | Yes | The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
NextToken | string | No | The token that is used for the next query. Valid values:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
MaxResult | integer | No | The number of entries to return on each page. Valid values: 1 to 50. Default value: 50. | 50 |
ResourceId | array | No | ||
string | No | The ID of the resource. You can enter at most 50 IDs. Note
If you set this parameter, you must set ResourceType.
| vpc-bp16qjewdsunr41m1**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "DE65F6B7-7566-4802-9007-96F2494AC512",
"TagKeys": {
"TagKey": [
{
"Type": "Custom",
"TagKey": "FinanceDept"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | BothEmpty.TagsAndResources | The specified Tags and ResourcesIds are not allow to both empty. | The tags and resource groups cannot be empty at the same time. |
400 | MissingParameter.TagKey | The input parameter TagKey that is mandatory for processing this request is not supplied. | The TagKey parameter is not set. |
400 | MissingParameter.TagValue | The input parameter TagValue that is mandatory for processing this request is not supplied. | The TagValue parameter is not set. |
400 | InvalidTagKey | The tag keys are not valid. | The tag index is invalid. |
400 | InvalidTagValue | The tag values are not valid. | The tag value is invalid. |
400 | MissingParam | %s | - |
400 | InvalidInstanceType.NotFound | The instance type is not found | The instance type is not found. |
400 | InvalidInstanceIds.NotFound | The instanceIds are not found | The instance ID is not found. |
400 | Forbidden.TagKeys | The request do not allow to operate the tag keys | You do not have the permissions to set the TagKeys parameter. |
400 | QuotaExceeded.TagNum | Custom Tags quota exceeded | The upper limit is reached. |
400 | Forbidden.NotAllowedCategary | The System tag is not valid | The error message returned because the system tag is invalid. |
400 | Forbidden.TagKeys | The request does not allow operate this tagkeys | The error message returned because you cannot manage the tag key by calling the operation. |
400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | The tag resources are duplicate. |
400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | The number of tags has reached the upper limit. |
400 | SizeLimitExceeded.ResourceId | The maximum number of resource IDs is exceeded. | The number of resource group IDs has reached the upper limit. |
403 | Forbidden | User not authorized to operate on the specified resource. | You do not have the permissions to manage the specified resource. Apply for the permissions and try again. |
For a list of error codes, visit the Service error codes.