阅读359 返回首页    go 魔兽

查询标签__标签相关接口_API 参考_云服务器 ECS-阿里云

描述

  • 容许根据资源类型、资源 ID、Tag-Key、Tag-Value 等条件查询所有符合条件的 Tags。

  • 指定的条件为 and 关系，只有指定的所有条件都满足的TagSetItem才会被返回。

  • 如果指定了 Tag-Key 但没有指定 Tag-Value，就查询所有该 Tag-Key 关联的 Tag。

  • 如果指定了 Tag-Key/Tag-Value 对，就查询精确匹配该 Tag-Key/Tag-Value 对的 Tag。

请求参数

名称 类型 是否必须 描述
Action String 是 操作接口名，DescribeTags
RegionId String 是 所属区域
ResourceId String 否 ResourceId
ResourceType String 否 资源类型：
  • image
  • instance
  • snapshot
  • disk
  • securitygroup
所有值均为小写。
Tag.n.Key String 否 标签 key，n 从 1 开始，最大为 5
Tag.n.Value String 否 标签 value，n 从 1 开始，最大为 5
PageSize Integer 否 默认 50，最大 100
PageNumber Integer 否 实例状态列表的页码，起始值为 1，默认值为 1

返回参数

名称 类型 描述
RequestId String 请求ID
TagSet TagSetItem 实际返回内容的结构体列表
PageSize Integer 默认 50，最大 100
PageNumber Integer 实例状态列表的页码，起始值为 1，默认值为 1
TotalCount Integer 实例总个数

错误类型

错误代码 描述 Http状态码 语义
MissingParameter The input parameter "RegionId" that is mandatory for processing this request is not supplied. 400 RegionId 参数未指定
InvalidRegionId.NotFound The RegionId provided does not exist in our records. 404 指定的 RegionId 不存在
InvalidResourceType.NotFound The ResourceType provided does not exist in our records. 404 指定的 ResourceType 不存在
InvalidTagCount The specified tags are beyond the permitted range 400 指定的 Tag 数超过了 5 个

示例

请求示例

https://ecs.aliyuncs.com/?Action=AddTags
&ResourceId=s-946ntx4wr
&ResourceType=snapshot
&RegionId=cn-shenzhen
&Tag.1.Key=test
&Tag.1.Value=api
&<公共请求参数>

返回示例

XML格式

<DescribeTagsResponse>
    <RequestId>B04B8CF3-4489-432D-83BA-6F128E4F2295</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>50</PageSize>
    <Tags>
        <Tag>
            <TagKey>test</TagKey>
            <TagValue>api</TagValue
        </Tag>
    </Tags>
    <TotalCount>1</TotalCount>
</DescribeTagsResponse>

JSON格式

{
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "B04B8CF3-4489-432D-83BA-6F128E4F2295",
  "Tags": {
    "Tag": [
      {
        "TagKey": "test",
        "TagValue": "api"
      }
    ]
  },
  "TotalCount": 1
}

最后更新：2016-11-23 16:03:51

  上一篇：go 解绑标签__标签相关接口_API 参考_云服务器 ECS-阿里云
  下一篇：go 查询实例资源规格列表__其他接口_API 参考_云服务器 ECS-阿里云