查询云资源已经绑定的标签列表。
接口说明
-
请求中至少指定参数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代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:ListTagResources | get | *BandwidthPackage acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/{#BandwidthPackageId}*Address acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}*NatGateway acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}*RouteTable acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTable}*VPC acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}*VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}*VSwitch acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ResourceType | string | 是 | 资源类型。取值：
说明
输入的资源类型取值不区分大小写。
| VPC |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults | integer | 否 | 分页大小，取值范围：1~50，默认值：50。 | 50 |
| ResourceId | array | 否 | 资源 ID。最多支持 50 个资源 ID。 | |
| 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 |
返回参数
示例
正常返回示例
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.TagKeys | The request does not allow operate this tagkeys | 该请求不允许操作此 tagkey |
| 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. | 您没有权限操作指定资源，请申请权限后再操作。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-07-28 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-07-10 | OpenAPI 错误码发生变更 | 查看变更详情 |