ListTagResources - 查询标签

更新时间:
复制 MD 格式

根据地域ID以及资源类型查询标签。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:ListTagResources

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID,取值范围如下:

  • 中国站:cn-hangzhou

  • 国际站:ap-southeast-1

cn-hangzhou

ResourceId

array

资源 ID。请输入站点 ID 或者 DNS 记录 ID。ResourceId 和 Tag 至少须提供其一。

string

资源 ID。请输入站点 ID 或者 DNS 记录 ID。

123456xxxxx

Tag

array<object>

标签列表。最多可输入 20 个标签。ResourceId 和 Tag 至少须提供其一。

object

标签列表。最多可输入 20 个标签。

Key

string

标签键。

env

Value

string

标签值。

value

ResourceType

string

资源类型。取值范围如下:

  • 站点:site

  • DNS 记录:record

site

NextToken

string

下一个查询开始 Token,用来返回更多结果。

说明

第一次查询不需要提供本参数,如果一次查询没有返回全部结果,则可在后续查询中传入前一次返回的 NextToken 值以继续查询。

AAAAAZjtYxxxxxxxx

MaxItem

integer

最多个数。

20

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

CB1A380B-09F0-41BB-280B-72F8FD6DA2FE

NextToken

string

下一个查询开始 Token。NextToken 为空,说明当页已显示完所有信息。

AAAAAYwsxxxxxxx

TagResources

array<object>

资源标签。

object

资源标签。

TagKey

string

标签键。

env

TagValue

string

标签值。

value

ResourceId

string

资源 ID。请输入站点 ID 或者 DNS 记录 ID。

example.com

ResourceType

string

资源类型。取值范围如下:

  • 站点:site

  • DNS 记录:record

site

TotalCount

integer

总条数。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "CB1A380B-09F0-41BB-280B-72F8FD6DA2FE",
  "NextToken": "AAAAAYwsxxxxxxx",
  "TagResources": [
    {
      "TagKey": "env",
      "TagValue": "value",
      "ResourceId": "example.com",
      "ResourceType": "site"
    }
  ],
  "TotalCount": 1
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.TagValue The specified TagValue is invalid. TagValue参数无效。
400 InvalidNextToken The specified parameter NextToken is invalid. 参数NextToken非法。
404 InvalidResourceId.NotFound The specified resource does not exist or is released. 资源不存在或已被释放。

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

变更历史

更多信息,参考变更详情