开发者社区 问答 正文

标签相关API:DescribeTags


描述

  • 允许根据实例ID/Tagkey/Tagvalue等条件查询所有符合条件的Tags。
  • 指定的条件为and关系,只有满足所有指定条件的TagSet才会被返回。
  • 如果指定了Tagkey而没有指定Tagvalue,就查询所有该Tagkey关联的Tag。
  • 不允许用户只指定Tagvalue而不指定Tagkey。
  • 若指定了Tagkey/Tagvalue对,则精确匹配该Tag。


请求参数


                                                                                                                                                                                                                                                                            
名称类型是否必须描述
ActionString操作接口名,系统规定参数。取值:DescribeTags。
RegionIdString负载均衡实例所属的Region编号。取值:从DescribeRegions的返回值中选取。
LoadBalancerIDString负载均衡实例ID。
Tags String需要查询的Tag列表。
取值:是一个Json string,其结构是一个JsonList。一次请求中,List中的元素个数最多5个。List元素的结构详见下表。
PageSize  Integer默认50,最大100。
PageNumber  Integer实例列表页码,起始值1,默认值1。

Tags元素:
                                                                                                                                        
名称类型是否必须描述
TagKeyString否   最多支持64个字
不支持aliyun开头
不允许为空。
TagValue String否  最多支持128个字符
不支持aliyun开头。


返回参数


                                                                                                                                                                                                                                                                                                                                                
名称类型描述
<公共参数>详见 <公共返回参数>
TagSetsListJSON格式的数据列表,每项参数如下表所示。
PageSizeInteger默认50,最大100。
PageNumberInteger实例列表页码,起始值1,默认值1。
TotalCountInteger根据过滤条件得到的实例总个数。

TagSets结构:
                                                                                                                                                                                                                                                                              
名称类型描述
<公共参数>详见 <公共返回参数>
TagKeyString标签Key。
TagValueString标签Value。
InstanceCountInteger该标签绑定的实例总数。


示例



请求示例

  1. https://slb.aliyuncs.com/
  2. &Action=DescribeTags
  3. &RegionId=cn-east-hangzhou-01
  4. &LoadBalancerID=139a00604ad-cn-east-hangzhou-01
  5. &<公共请求参数>


返回示例


  • XML 格式
    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeTagsResponse>
    3.   <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4.    <TagSets>
    5.       <TagSet>
    6.           <TagKey>test</TagKey>
    7.           <TagValue>api</TagValue>
    8.       </TagSet>
    9.   </TagSets>
    10.   <PageSize>50</PageSize>
    11.   <PageNumber>1</PageNumber>
    12.   <TotalCount>1</TotalCount>
    13. </DescribeTagsResponse>

  • JSON格式
    1.   {
    2. "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
    3. "TagSets": {
    4.   "TagSet": [
    5.     {
    6.       "TagKey": "test",
    7.       "TagValue": "api"
    8.     }
    9. "PageNumber": 1,
    10. "PageSize": 50,
    11. "TotalCount": 1
    12.   }

展开
收起
行者武松 2017-10-18 15:23:53 2299 分享 版权
0 条回答
写回答
取消 提交回答