Queries tags.
Operation description
When you call this operation, take note of the following items:
- You can query tags by instance ID, tag key, and tag value. If the operation is successful, the system returns all tags that match the specified conditions.
- The logical relationship among the specified conditions is AND. Only tags that match all the specified conditions are returned.
- If the Tagkey parameter is set and the Tagvalue parameter is not set, all tags that contain the specified tag key are returned.
- If you set the Tagvalue parameter in a request, you must also set the Tagkey parameter in the request.
- If you set both the Tagkey and Tagvalue parameters, only tags that contain the specified keys and values are returned.
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 |
---|---|---|---|---|
slb:DescribeTags | LIST |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region where the Server Load Balancer (SLB) instance is deployed. | cn-hangzhou |
LoadBalancerId | string | No | The ID of the SLB instance. | 139a00604ad-cn-east-hangzhou-01 |
Tags | string | No | The tags that you want to query. | [{"TagKey":"Key1","TagValue":"Value1"},{"TagKey":"Key2","TagValue":"Value2"}] |
DistinctKey | boolean | No | Specifies whether the tag is DistinctKey. Valid values: true and false. | false |
PageSize | integer | No | The number of entries to return on each page. Default value: 50. Maximum value: 100. | 50 |
PageNumber | integer | No | The number of the page to return. Minimum value: 1. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
"PageSize": 50,
"PageNumber": 1,
"TotalCount": 1,
"TagSets": {
"TagSet": [
{
"TagValue": "api",
"InstanceCount": 10,
"TagKey": "test"
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.