You can call the DescribeTags API to query the details of added tags.

Before you call this API, note the following:

  • You can use the SLB instance ID, TagKey, or TagValue to search for tags that meet your search conditions.
  • The relationship between the conditions is "AND". Only tags that meet all the specified conditions will be returned.
  • If you specify a TagKey without specifying a TagValue, all tags associated with the TagKey will be queried.
  • A TagValue must be specified with a TagKey. However, a TagKey can be specified without a TagValue.
  • If a TagKey/TagValue pair is specified, then exact matching is performed.


Click here to perform a debug operation in OpenAPI Explorer and automatically generate an SDK code example.

Request parameters

Name Type Required? Example value Description
Action String Yes DescribeTags


RegionId String Yes cn-hangzhou

The ID of the region to which the SLB instance belongs

DistinctKey Boolean No false

Whether it is DistinctKey.

Valid values: true | false

LoadBalancerId String No 139a00604ad-cn-east-hangzhou-01

The ID of the SLB instance

PageNumber Integer No 1

The page number of the SLB instance list. Initial value: 1. Default value: 1.

PageSize Integer No 50

The number of results per page. Default value: 50. Maximum value: 100.

Tags String No [{"TagKey":"Key1","TagValue":"Value1"}{"TagKey":"Key2","TagValue":"Value2"}]

A list of tags to query

Response parameters

Name Type Example value Description

The list of tags

  └TagKey String test

The tag key

  └TagValue String api

The tag value

  └InstanceCount Integer 10

The total number of SLB instances where the tag is attached.

PageSize Integer 50

Default value: 50. Maximum value: 100.

PageNumber Integer 1

The page number of the SLB instance list. Initial value: 1. Default value: 1.

TotalCount Integer 1

The total number of instances that meet your search conditions

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request


Request example
&<Common request parameters>
? Action=DescribeTags
&<Common request parameters>

Normal response examples

XML format


JSON format


Error codes

Click here to view the error codes.