查询云资源已经绑定的标签列表。
接口说明
-
请求中至少指定参数ResourceId.N或Tag.N(Tag.N.Key与Tag.N.Value),以确定检索对象。
-
Tag.N是资源的标签,由一个键值对组成。仅指定Tag.N.Key时,则返回该标签键关联的所有标签值。仅指定Tag.N.Value会报错。
-
如果您同时指定Tag.N和ResourceId.N筛选标签,则ResourceId.N必须满足所有输入的标签键值对。
-
如果您同时指定多个标签键值对,返回结果为同时包含被指定的多个键值对的资源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vpc:ListTagResources |
get |
BandwidthPackage
Address
NatGateway
RouteTable
VPC
VpnGateway
VSwitch
|
|
无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ResourceType |
string |
是 |
资源类型。取值:
说明
输入的资源类型取值不区分大小写。 |
VPC |
| NextToken |
string |
否 |
是否拥有下一次查询的令牌(Token)。取值:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults |
integer |
否 |
分页大小,取值范围:1~50,默认值:50。 |
50 |
| ResourceId |
array |
否 |
资源 ID。最多支持 50 个资源 ID。 |
vpc-bp16qjewdsunr41m1**** |
|
string |
否 |
资源 ID。最多支持输入 50 个资源 ID。 说明
参数ResourceId.N或Tag.N(Tag.N.Key与Tag.N.Value)至少输入一个。 |
vpc-bp16qjewdsunr41m1**** |
|
| RegionId |
string |
是 |
资源所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 |
cn-hangzhou |
| Tag |
array<object> |
否 |
标签信息。 |
ListTagResources |
|
object |
否 |
资源的标签键。 |
||
| Key |
string |
否 |
资源的标签键。最多支持 20 个标签键。 一个标签键最多支持 128 个字符,不能是空字符串,不能以 说明
参数ResourceId.N或Tag.N(Tag.N.Key与Tag.N.Value)至少输入一个。 |
FinanceDept |
| Value |
string |
否 |
资源的标签值。最多支持 20 个标签值。 最多支持 128 个字符,可以是空字符串,不能以 说明
参数ResourceId.N或Tag.N(Tag.N.Key与Tag.N.Value)至少输入一个。 |
FinanceJoshua |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回的信息。 |
||
| NextToken |
string |
是否拥有下一次查询的令牌(Token)。取值:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| RequestId |
string |
请求 ID。 |
DE65F6B7-7566-4802-9007-96F2494AC512 |
| TagResources |
object |
||
| TagResource |
array<object> |
绑定标签的资源信息。 |
|
|
object |
绑定标签的资源信息。 |
||
| ResourceType |
string |
资源类型。取值:
|
VPC |
| TagValue |
string |
标签值。 |
FinanceJoshua |
| ResourceId |
string |
资源 ID。 |
vpc-bp16qjewdsunr41m1**** |
| TagKey |
string |
标签键。 |
FinanceDept |
示例
正常返回示例
JSON格式
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "DE65F6B7-7566-4802-9007-96F2494AC512",
"TagResources": {
"TagResource": [
{
"ResourceType": "VPC",
"TagValue": "FinanceJoshua",
"ResourceId": "vpc-bp16qjewdsunr41m1****",
"TagKey": "FinanceDept"
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidTagKey | The tag keys are not valid. | 无效的标签索引 |
| 400 | InvalidTagValue | The tag values are not valid. | 无效的标签值 |
| 400 | MissingParam | %s | |
| 400 | InvalidInstanceType.NotFound | The instance type is not found | 实例类型没有找到 |
| 400 | InvalidInstanceIds.NotFound | The instanceIds are not found | 实例ID没有找到 |
| 400 | Forbidden.TagKeys | The request do not allow to operate the tag keys | 没有权限操作TagKeys |
| 400 | QuotaExceeded.TagNum | Custom Tags quota exceeded | quota超限 |
| 400 | Forbidden.NotAllowedCategary | The System tag is not valid | 系统tag无效 |
| 400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | 标签资源重复 |
| 400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | 标签数量超限 |
| 400 | SizeLimitExceeded.ResourceId | The maximum number of resource IDs is exceeded. | 资源组ID数目超限 |
| 400 | BothEmpty.TagsAndResources | The specified Tags and ResourcesIds are not allow to both empty. | 标签和资源组不能同时为空 |
| 400 | MissingParam.ResourceType | The param of ResourceType is missing. | 参数ResourceType缺失 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您没有权限操作指定资源,请申请权限后再操作。 |
| 403 | BothEmpty.TagsAndResources | The specified Tags and ResourcesIds are not allow to both empty. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。