You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
云服务器
  • 文档首页
    • /
  • 云服务器

DescribeTags

最近更新时间：2023.07.25 18:39:31

首次发布时间：2022.09.02 08:59:16

我的收藏

调用 DescribeTags 接口查询已绑定标签的资源。

说明

  • 单次调用该接口最多支持查询10个标签。
  • 同一标签键最多支持同时查询3个标签值。

请求参数

名称类型是否必填示例值描述
ActionString是DescribeTags要执行的操作，取值：DescribeTags。
VersionString是2020-04-01API的版本，取值：2020-04-01。

ResourceType

String

是

instance

资源类型，取值：

  • instance：实例

  • image：镜像

  • reservedinstance：预留实例券

    预留实例券正在邀测中，如需试用，请提交工单或联系客户经理申请。

ResourceIds.N

String

是

ResourceIds.1=i-l8u0p77yseabkpak****&ResourceIds.2=i-l8u0p7xyseabkbak****

资源ID。

  • 参数 - N：表示资源的序号，取值范围：1～50。
  • 多个资源之间用&分隔。

TagFilters.N.Key

String

否

TagFilters.1.Key=k1

根据标签查询资源时指定的标签键。

  • 参数 - N：表示标签键的序号，取值范围：1～10。

  • 多个标签键之间用&分隔，不允许重复。

说明

  • 不传则表示查询所有标签。
  • 传入空字符串时，则返回错误码InvalidTagFilterKey.Malformed。

TagFilters.N.Values.N

String

否

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

根据标签查询资源时指定的标签值。

  • 第一个N：表示标签键的序号，取值范围：1～10。

  • 第二个N：表示标签值的序号，取值范围：1～3。

  • 多个标签值之间用&分隔。

说明

  • 如果传入该参数，则必须先传入TagFilters.N.Key。
  • 不传则表示查询同一标签键下的所有标签值。
  • 传入空字符串时，表示查询标签值为空的标签。

NextToken

String

否

bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

MaxResults

Integer

否

10

分页查询时设置的每页行数：

  • 最大值：100
  • 默认值：10

返回数据

名称
类型
示例值
描述
TagResources
Array of Struct
-
由资源及其标签组成的集合。
NextToken
String
bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******
本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=DescribeTags&Version=2020-04-01&ResourceType=instance&ResourceIds.1=i-l8u0p77yseabkpak****&ResourceIds.2=i-l8u0p7xyseabkbak****&TagFilters.1.Key=k1&TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeTags",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "NextToken": "bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******"
        "TagResources": [
            {
                "ResourceType": "instance",
                "ResourceId": "i-l8u0p77yseabkpak****",
                "TagKey": "k1",
                "TagValue": "v1"
            },
            {
                "ResourceType": "instance",
                "ResourceId": "i-l8u0p7xyseabkbak****",
                "TagKey": "k1",
                "TagValue": "v2"
            }
        ]
    }
}

错误码

HttpCode错误码错误信息描述
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。

404

InvalidResourceType.NotFound

The specified ResourceType does not exist.

指定的资源类型不存在。

400

LimitExceeded.MaximumResourceIds

You've reached the limit on the number of ResourceIds that you can set.

指定的资源ID数量超过最大限制。

400

LimitExceeded.MaximumTagFilterKeys

You've reached the limit on the number of TagFilterKeys that you can set.

指定的标签键数量超过最大限制。

400

LimitExceeded.MaximumTagFilterValues

You've reached the limit on the number of TagFilterValues that you can set.

指定的标签值数量超过最大限制。

400InvalidTagFilterKey.MalformedThe specified TagFilterKey is malformed.指定的标签键不合法。
400InvalidTagFilterValue.MalformedThe specified TagFilterValue is malformed.指定的标签值不合法。
409InvalidTagFilterKey.ConflictThe specified TagFilterKey already exists.指定的标签键已存在。
500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。