ListTagResources - 查询标签列表
查询一个或多个EAIS资源已经绑定的标签列表。
接口说明
请求中至少指定以下任一参数,以确定查询对象。
ResourceId.N
Tag.N(Tag.N.Key 与 Tag.N.Value)
同时指定 Tag.N 和 ResourceId.N 参数时,返回结果中仅包含同时满足这两个条件的 EAIS 资源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
eais:ListTagResources |
none |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
资源所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| NextToken |
string |
否 |
下一个查询开始 Token。 |
caeba0bbb2be03f84eb48b699f0a4884 |
| ResourceType |
string |
是 |
资源类型定义。目前取值仅支持 |
instance |
| ResourceId |
array |
否 |
资源 ID,最多 50 个子项。 |
|
|
string |
否 |
资源 ID。 |
eais-hzs4h26yyt5xkcke**** |
|
| Tag |
array<object> |
否 |
标签列表,最多包含 20 个子项。 |
|
|
object |
否 |
标签对象。 |
||
| Key |
string |
否 |
标签键。限制:
|
TestKey |
| Value |
string |
否 |
标签值。限制:
|
TestValue |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
F23AEEC7-4D98-4657-A104-02692701**** |
| NextToken |
string |
下一个查询开始 Token。NextToken 为空说明为最后一个。 |
caeba0bbb2be03f84eb48b699f0a4885 |
| TagResources |
array<object> |
由资源及其标签组成的集合,包含了资源 ID、资源类型和标签键值等信息。 |
|
|
object |
资源及标签信息对象。 |
||
| TagKey |
string |
标签键。 |
TestKey |
| TagValue |
string |
标签值。 |
TestValue |
| ResourceId |
string |
资源 ID。 |
eais-hzs4h26yyt5xkcke**** |
| ResourceType |
string |
资源类型。 |
instance |
示例
正常返回示例
JSON格式
{
"RequestId": "F23AEEC7-4D98-4657-A104-02692701****",
"NextToken": "caeba0bbb2be03f84eb48b699f0a4885",
"TagResources": [
{
"TagKey": "TestKey",
"TagValue": "TestValue",
"ResourceId": "eais-hzs4h26yyt5xkcke****",
"ResourceType": "instance"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | MissingParameter.ResourceIdOrTag | Either ResourceId or Tag must be specified. | ResourceId和Tag至少有一个必填。 |
| 400 | InvalidNextToken | The NextToken is invalid. | NextToken参数非法。 |
| 400 | NumberExceed.ResourceIds | The maximum number of ResourceIds is exceeded. The maximum is 50. | 传入的资源ID数量达到上限,最多支持50个。 |
| 400 | MissingParameter.ResourceIds | You must specify ResourceIds. | ResourceId不能为空。 |
| 400 | Duplicate.ResourceId | The request contains duplicated ResourceId. | ResourceId不能重复。 |
| 400 | NumberExceed.Tags | The maximum number of Tags is exceeded. The maximum is 20. | 传入的Tag数量达到上限,最多支持20个。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contains a duplicated key. | 传入的TagKey重复。 |
| 400 | InvalidResourceId.NotFound | The ResourceId does not exist. | ResourceId不存在。 |
| 400 | InvalidParameter.TagKey | The specified Tag.n.Key is invalid. | TagKey为非法值。 |
| 400 | InvalidParameter.TagValue | The specified Tag.n.Value is invalid. | TagValue为非法值。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。