閱讀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-阿裏雲