ListTagResources - 查询对等连接已经绑定的标签列表

调用ListTagResources接口查询对等连接已经绑定的标签列表。

接口说明

  • 请求中至少指定参数ResourceId.NTag.NTag.N.KeyTag.N.Value),以确定检索对象。
  • Tag.N是资源的标签,由一个键值对组成。仅指定Tag.N.Key时,则返回该标签键关联的所有标签值。仅指定Tag.N.Value会报错。
  • 如果您同时指定Tag.NResourceId.N筛选标签,则ResourceId.N必须满足所有输入的标签键值对。
  • 如果您同时指定多个标签键值对,返回结果为同时包含被指定的多个键值对的资源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:ListTagResourceslist
*全部资源
*

请求参数

名称类型必填描述示例值
ResourceTypestring

资源类型。取值:PeerConnection,VPC 对等连接。

PeerConnection
ResourceIddeprecatedarray

资源 ID。最多支持 20 个资源 ID。

string

资源 ID。最多支持输入 20 个资源 ID。

说明 参数ResourceId.NTag.NTag.N.KeyTag.N.Value)至少输入一个。
pcc-bp16qjewdsunr41m1****
Tagdeprecatedarray<object>

标签信息。

object

资源的标签键。

Keystring

资源的标签键。最多支持 20 个标签键。一旦传入该值,则不允许为空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

说明 参数ResourceId.NTag.NTag.N.KeyTag.N.Value)至少输入一个。
FinanceDept
Valuestring

资源的标签值。最多支持 20 个标签值。一旦传入该值,可以为空字符串。

一个标签值最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

说明 参数ResourceId.NTag.NTag.N.KeyTag.N.Value)至少输入一个。
FinanceJoshua
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~50,默认值:50

50
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****
RegionIdstring

资源所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
Categorystring

标签类型。

  • All(默认值)

  • Custom

  • System

All

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

DE65F6B7-7566-4802-9007-96F2494AC512
TagResourcesarray<object>

绑定标签的资源信息。

TagResultModelListobject

绑定标签的资源信息。

ResourceIdstring

资源 ID。

pcc-bp16qjewdsunr41m1****
ResourceTypestring

资源类型。取值:PeerConnection,VPC 对等连接。

PeerConnection
RegionNostring

VPC 对等连接发起方的地域。

cn-hangzhou
TagKeystring

标签键。

FinanceDept
TagValuestring

标签值。

FinanceJoshua
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

50

示例

正常返回示例

JSON格式

{
  "RequestId": "DE65F6B7-7566-4802-9007-96F2494AC512",
  "TagResources": [
    {
      "ResourceId": "pcc-bp16qjewdsunr41m1****",
      "ResourceType": "PeerConnection",
      "RegionNo": "cn-hangzhou",
      "TagKey": "FinanceDept",
      "TagValue": "FinanceJoshua"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 50
}

错误码

HTTP status code错误码错误信息描述
400InvalidTagKeyThe tag keys are not valid.无效的标签索引
400NumberExceed.TagsThe maximum number of tags is exceeded.标签数量超限
400NumberExceed.ResourceIdsThe maximum number of resource IDs is exceeded.资源组ID数目超限
400Forbidden.TagKeysThe tag key cannot be operated by the request.该请求不允许操作此 tagkey
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.标签资源重复
400InvalidInstanceIds.NotFoundThe instance IDs are not found.实例ID没有找到
400InvalidInstanceType.NotFoundThe instance type is not found.实例类型没有找到
400BothEmpty.TagsAndResourcesThe specified Tags and ResourcesIds are not allow to both empty.标签和资源信息不能同时为空。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-02-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2025-02-10OpenAPI 错误码发生变更查看变更详情
2023-12-08OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-07-25OpenAPI 错误码发生变更查看变更详情