DescribeTags--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeTags

最近更新时间：2024.11.01 18:49:26首次发布时间：2023.03.03 16:32:18

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

注意事项

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

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeTags	要执行的操作，取值：DescribeTags
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ResourceType	String	是	volume	资源类型，取值： volume：云盘。
ResourceIds.N	String	是	ResourceIds.1=vol-76pwr6rilv8lzwxv**&ResourceIds.2=vol-76pwr6rilv8lzwxv**	需要查询标签的资源ID。说明如下： ResourceIds.N：`N`表示资源的序号。取值范围：1～50。多个资源之间用`&`分隔。
TagFilters.N.Key	String	否	TagFilters.1.Key=tag	根据标签查询资源时指定的标签键。说明如下： TagFilters.N.Key：`N`表示标签键的序号。取值范围：1～10。多个标签键之间用`&`分隔，不允许重复。不传入该参数则表示查询所有标签。传入空字符串时，则返回错误码`InvalidTagFilterKey.Malformed`。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test	根据标签查询资源时指定的标签值。说明如下： TagFilters.N.Values.N：第一个`N`表示标签键的序号。取值范围：1～10。 TagFilters.N.Values.N：第二个`N`表示标签值的序号。取值范围：1～3。多个标签值之间用`&`分隔。如果传入该参数，则必须先传入`TagFilters.N.Key`。不传入该参数则表示查询同一标签键下的所有标签值。传入空字符串时，表示查询标签值为空的标签。
SysTagVisible	Boolean	否	false	是否展示系统标签。取值范围如下： true：展示系统标签。 false：不展示系统标签。默认值为`false`。
PageNumber	Integer	否	1	页数索引。
PageSize	Integer	否	15	分页的页容量。

返回数据

名称	类型	示例值	描述
PageNumber	Integer	1	页数索引。
PageSize	Integer	15	分页的页容量。
TagResources	Array of TagResources	-	由资源及其标签组成的集合。具体请参见下表TagResources 结构。
TotalCount	Integer	1	符合条件的资源总数。

TagResources 结构

名称	类型	示例值	描述
ResourceType	String	volume	资源类型，取值： volume：云盘。 snapshot：快照。 snapshotpolicy：自动快照策略。
ResourceId	String	vol-jfrnoryrnpgn6u5w****	资源ID。
TagKey	String	tag	资源附加标签的标签键。
TagValue	String	test	资源附加标签的标签值。

请求示例

GET /?Action=DescribeTags&Version=2020-04-01&ResourceType=volume&ResourceIds.1=vol-76pwr6rilv8lzwxv*****&ResourceIds.2=vol-76pwr6rilv8lzwxv**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230303143154E698024A111791BD1EA2",
        "Action": "DescribeTags",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 15,
        "TagResources": [
            {
                "ResourceId": "vol-jfrnoryrnpgn6u5w****",
                "ResourceType": "volume",
                "TagKey": "tag",
                "TagValue": "test"
            }
        ],
        "TotalCount": 1
    }
}

错误码

HttpCode	错误码	错误信息
400	ErrTagServiceUnable	tag服务禁用
400	ErrTagNotFound	tag参数为空
400	InvalidTagKeyConflict	tag参数重复
400	ErrInvalidTagCount	tag数量过多
400	ErrInvalidTagKey	tag key非法
400	ErrInvalidTagValue	tag value非法
400	ErrTagKeyNotFound	tag key为空
400	ErrInvalidResourceIdNotFound	resource id为空
400	ErrMaximumResourceIds	resource id数量过多
400	ErrResourceTypeNotFound	resource type为空
400	ErrResourceTypeUnknown	resource type未知
400	ErrInvalidTagKeyCount	tag key数量过多
400	ErrInvalidAccountId	account id非法
400	ErrMaximumTagFilterKeys	tag filter key数量过多
400	InvalidTagFilterKeyConflict	tag filter key重复
400	ErrInvalidTagFilterKey	tag filter key非法
400	ErrMaximumTagFilterValues	tag filter value数量过多
400	ErrInvalidTagFilterValue	tag filter value非法