DescribeTags - Server Load Balancer - Alibaba Cloud Documentation Center

Queries tags.

Operation description

Take note of the following items:

The system queries tags based on the instance ID, tag key, and tag value specified by you.
If the logical relationship among the specified conditions is AND, only tags that match all the specified conditions are returned.
If the Tagkey parameter is specified and but Tagvalue parameter is not specified, all tags that contain the specified tag key are returned.
If you specify the Tagvalue parameter in a request, you must also specify the Tagkey parameter in the request.
If you specify both the Tagkey and Tagvalue parameters, only tags that contain the specified keys and values are returned.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Server Load Balancer (SLB) instance.	cn-hangzhou
LoadBalancerId	string	No	The SLB instance ID.	lb-bp1kuzybm******
Tags	string	No	The tags that you want to query.	[{"TagKey":"Key1","TagValue":"Value1"},{"TagKey":"Key2","TagValue":"Value2"}]
DistinctKey	boolean	No	Specifies whether the tags contain distinct keys. 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

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710
PageSize	integer	The number of entries returned per page. Default value: 50. Maximum value: 100.	50
PageNumber	integer	The number of the returned page. Minimum value: 1. Default value: 1.	1
TotalCount	integer	The number of instances returned.	1
TagSets	array<object>	The tags that are queried.
TagSet	object
TagValue	string	The tag value.	api
InstanceCount	integer	The number of instances to which the tag is added.	10
TagKey	string	The tag key.	test

Examples

Sample success responses

JSONformat

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": 1,
  "TagSets": {
    "TagSet": [
      {
        "TagValue": "api",
        "InstanceCount": 10,
        "TagKey": "test"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission.Operator	The operator is not permission for this operate.

For a list of error codes, visit the Service error codes.