ListTagResources - 查询标签

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

调试

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

授权信息

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

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

请求参数

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

地域 ID,取值范围如下:

  • 中国站:cn-hangzhou
  • 国际站:ap-southeast-1
cn-hangzhou
ResourceIdarray

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

string

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

123456xxxxx
Tagarray<object>

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

object

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

Keystring

标签键。

env
Valuestring

标签值。

value
ResourceTypestring

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

  • 站点:site
  • DNS 记录:record
site
NextTokenstring

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

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

最多个数。

20

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

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

AAAAAYwsxxxxxxx
TagResourcesarray<object>

资源标签。

TagResourceobject

资源标签。

TagKeystring

标签键。

env
TagValuestring

标签值。

value
ResourceIdstring

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

example.com
ResourceTypestring

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

  • 站点:site
  • DNS 记录:record
site
TotalCountinteger

总条数。

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错误码错误信息描述
400InvalidParameter.TagValueThe specified TagValue is invalid.TagValue参数无效。
400InvalidNextTokenThe specified parameter NextToken is invalid.参数NextToken非法。
404InvalidResourceId.NotFoundThe specified resource does not exist or is released.资源不存在或已被释放。

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

变更历史

变更时间变更内容概要操作
2024-09-18OpenAPI 错误码发生变更查看变更详情