DescribeTags_云服务器 ECS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

如果您指定了标签键(Tag.N.Key)但没有指定标签值(Tag.N.Value),我们将查询该标签键对应的所有标签键值对。如果您指定了标签键值对,就查询精确匹配该键值对的标签。

流控信息

请求速率为1000/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ecs:DescribeTags
Get
全部资源
*

请求参数

字段名称字段详情
PageSizeinteger<int32>

分页查询时设置的每页行数。展开详情

示例值:50取值 <= 100
PageNumberinteger<int32>

标签列表的页码。展开详情

示例值:1取值 >= 1
ResourceTypestring

资源类型定义。取值范围:展开详情

示例值:snapshot
ResourceIdstring

标签绑定的资源 ID。例如,当资源类型(ResourceType)为实例(instance)时,资源 ID 可以理解为实例 ID。

示例值:s-946ntx4wr****
RegionIdstring

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-hangzhou
Categorystring
说明 该参数即将被弃用,为提高兼容性,建议您尽量使用其他参数。
示例值:null
Tagarray<object>

标签列表。

子级条数 <= 20

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:B04B8CF3-4489-432D-83BA-6F128E4F2295
PageSizeinteger<int32>

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

示例值:50
PageNumberinteger<int32>

标签列表的页码。

示例值:1
TotalCountinteger<int32>

标签总个数。

示例值:1
Tagsobject

返回示例

错误返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidTagCount
The specified tags are beyond the permitted range.诊断
400
InvalidTagKey.Malformed
The parameter Tag.n.Key is illegal.诊断
400
InvalidTagValue.Malformed
The parameter Tag.n.Value is illegal.诊断
400
Invalid.TagCategory
The parameter Category is illegal.诊断
404
InvalidRegionId.NotFound
The specified RegionId does not exist.诊断
404
InvalidResourceType.NotFound
The ResourceType provided does not exist in our records.诊断

变更历史

变更时间变更内容概要操作
2024-12-25
新增deprecated

相关示例