当您需要查询资源标签时,可调用ListTagResources接口,查询资源已经绑定的标签列表。
接口说明
-
请求中至少指定参数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代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
privatelink:ListTagResources |
get |
*VpcEndpoint
*VpcEndpointService
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ResourceId |
array |
否 |
资源 ID 列表。最多支持 50 个资源 ID。 |
|
|
string |
否 |
服务资源 ID。 |
ep-hp3i05294c2d2d****** |
|
| ResourceType |
string |
是 |
资源类型。取值:
|
vpcendpoint |
| Tag |
array<object> |
否 |
标签列表。 |
|
|
object |
否 |
资源的标签。 |
||
| Key |
string |
否 |
资源的标签键。最多支持 20 个标签键。一旦传入该值,则不允许为空字符串。 最多支持 64 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以 |
FinanceDept |
| Value |
string |
否 |
资源的标签值。最多支持 20 个标签值。一旦传入该值,可以为空字符串。 最多支持 128 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以 |
FinanceJoshua |
| ClientToken |
string |
否 |
客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 |
0c593ea1-3bea-11e9-b96b-88e9fe637760 |
| RegionId |
string |
是 |
资源所属的地域 ID。您可以通过调用 describeregions 接口获取地域 ID。 |
cn-hangzhou |
| NextToken |
string |
否 |
是否拥有下一次查询的令牌(Token)。取值:
|
caeba0bbb2be03f84eb48b699f0a**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
8D8992C1-6712-423C-BAC5-E5E817484C6B |
| TagResources |
array<object> |
绑定标签的资源信息。 |
|
|
object |
绑定标签的资源信息。 |
||
| TagKey |
string |
标签键。 |
endpoint |
| TagValue |
string |
标签值。 |
FinanceJoshua |
| ResourceId |
string |
资源 ID。 |
ep-hp3i05294c2d2d****** |
| ResourceType |
string |
资源类型。取值:
|
vpcendpoint |
| NextToken |
string |
是否拥有下一次查询的令牌(Token)。取值:
|
caeba0bbb2be03f84eb48b699f0a4883 |
示例
正常返回示例
JSON格式
{
"RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
"TagResources": [
{
"TagKey": "endpoint",
"TagValue": "FinanceJoshua",
"ResourceId": "ep-hp3i05294c2d2d******",
"ResourceType": "vpcendpoint"
}
],
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | DuplicatedTagKey | The tag keys is duplicated. | tag key重复 |
| 400 | MissingTagKeyParam | The tag key is empty. | The tag key is empty. |
| 400 | MissingTagValueParam | The tag value is empty. | The tag value is empty. |
| 400 | MissingResourceIdOrTagParam | The resource id and tag is empty. | The resource id and tag is empty. |
| 400 | IllegalTagKeyParam | IllegalTagKeyParam | IllegalTagKeyParam |
| 400 | IllegalTagValueParam | The tag value is Illegal. | The tag value is Illegal. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。