DescribeTags - Server Load Balancer - Alibaba Cloud Documentation Center

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

slb:DescribeTags

get

*All Resource

*

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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF3******
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	object
TagSet	array<object>	The tags that are queried.
	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

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.