最近更新时间：2024.03.14 10:18:59
首次发布时间：2023.03.03 16:32:18
调用 DescribeTags 接口查询已绑定标签的资源。
单次调用该接口最多支持查询10个标签。
同一标签键最多支持同时查询3个标签值。
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeTags | 要执行的操作，取值：DescribeTags |
ResourceType | String | 是 | volume | 资源类型，取值：
|
ResourceIds.N | String | 是 | ResourceIds.1=vol-76pwr6rilv8lzwxv****&ResourceIds.2=vol-76pwr6rilv8lzwxv**** | 需要查询标签的资源ID。说明如下：
|
TagFilters.N.Key | String | 否 | TagFilters.1.Key=tag | 根据标签查询资源时指定的标签键。说明如下：
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test | 根据标签查询资源时指定的标签值。说明如下：
|
SysTagVisible | Boolean | 否 | false | 是否展示系统标签。取值范围如下：
|
| PageNumber | Integer | 否 | 1 | 页数索引。 |
| PageSize | Integer | 否 | 15 | 分页的页容量。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PageNumber | Integer | 1 | 页数索引。 |
| PageSize | Integer | 15 | 分页的页容量。 |
| TagResources | Array of TagResources | - | 由资源及其标签组成的集合。具体请参见下表TagResources 结构。 |
| TotalCount | Integer | 1 | 符合条件的资源总数。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
ResourceType | String | volume | 资源类型，取值：
|
| 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非法 |