All Products
Search
Document Center

Server Load Balancer:DescribeTags

Last Updated:Mar 14, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
slb:DescribeTagsLIST
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Server Load Balancer (SLB) instance is deployed.

cn-hangzhou
LoadBalancerIdstringNo

The ID of the SLB instance.

139a00604ad-cn-east-hangzhou-01
TagsstringNo

The tags that you want to query.

[{"TagKey":"Key1","TagValue":"Value1"},{"TagKey":"Key2","TagValue":"Value2"}]
DistinctKeybooleanNo

Specifies whether the tag is DistinctKey.

Valid values: true and false.

false
PageSizeintegerNo

The number of entries to return on each page. Default value: 50. Maximum value: 100.

50
PageNumberintegerNo

The number of the page to return. Minimum value: 1. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

365F4154-92F6-4AE4-92F8-7FF34B540710
PageSizeinteger

Default value: 50. Maximum value: 100.

50
PageNumberinteger

The number of the returned page. Minimum value: 1. Default value: 1.

1
TotalCountinteger

The number of instances returned.

1
TagSetsobject []

A list of tags.

TagValuestring

The tag value.

api
InstanceCountinteger

The number of instances to which the tag is added.

10
TagKeystring

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

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