全部产品
Search

搜索本产品

    私网连接 PrivateLink：ListTagResources - 查询资源已经绑定的标签列表

    文档中心

    私网连接 PrivateLink：ListTagResources - 查询资源已经绑定的标签列表

    更新时间：Sep 26, 2024

    当您需要查询资源标签时，可调用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代码示例。

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    privatelink:ListTagResourcesget
    • VpcEndpoint
      acs:privatelink:*:{#accountId}:vpcendpoint/{#vpcendpointId}
    • VpcEndpointService
      acs:privatelink:*:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    ResourceIdarray否

    资源 ID 列表。最多支持 50 个资源 ID。

    string否

    服务资源 ID。

    		ep-hp3i05294c2d2d******
    ResourceTypestring是

    资源类型。取值：

    • vpcendpoint：终端节点。

    • vpcendpointservice：终端节点服务。

    		vpcendpoint
    Tagarray<object>否

    标签列表。

    object否

    资源的标签。

    Keystring否

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

    最多支持 64 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以aliyun和acs:开头，不能包含http://或者https://。

    		FinanceDept
    Valuestring否

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

    最多支持 128 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以aliyun和acs:开头，不能包含http://或者https://。

    		FinanceJoshua
    ClientTokenstring否

    客户端 Token，用于保证请求的幂等性。

    从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

    		0c593ea1-3bea-11e9-b96b-88e9fe637760
    RegionIdstring是

    资源所属的地域 ID。您可以通过调用 describeregions 接口获取地域 ID。

    		cn-hangzhou
    NextTokenstring否

    是否拥有下一次查询的令牌（Token）。取值：

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

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

    		caeba0bbb2be03f84eb48b699f0a****

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		8D8992C1-6712-423C-BAC5-E5E817484C6B
    TagResourcesarray<object>

    绑定标签的资源信息。

    TagModelobject

    绑定标签的资源信息。

    TagKeystring

    标签键。

    		endpoint
    TagValuestring

    标签值。

    		FinanceJoshua
    ResourceIdstring

    资源 ID。

    		ep-hp3i05294c2d2d******
    ResourceTypestring

    资源类型。取值：

    • vpcendpoint：终端节点。

    • vpcendpointservice：终端节点服务。

    		vpcendpoint
    NextTokenstring

    是否拥有下一次查询的令牌（Token）。取值：

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

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

    		caeba0bbb2be03f84eb48b699f0a4883

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "TagResources": [
    {
      "TagKey": "endpoint",
      "TagValue": "FinanceJoshua",
      "ResourceId": "ep-hp3i05294c2d2d******",
      "ResourceType": "vpcendpoint"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883"
}

    错误码

    HTTP status code错误码错误信息描述
    400DuplicatedTagKeyThe tag keys is duplicated.tag key重复
    400MissingTagKeyParamThe tag key is empty.The tag key is empty.
    400MissingTagValueParamThe tag value is empty.The tag value is empty.
    400MissingResourceIdOrTagParamThe resource id and tag is empty.The resource id and tag is empty.
    400IllegalTagKeyParamIllegalTagKeyParamIllegalTagKeyParam
    400IllegalTagValueParamThe tag value is Illegal.The tag value is Illegal.

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