调用ListTagResources,查询可见的资源标签关系。

调试

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

请求头

请求语法

GET /openapi/tags HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
ResourceType String INSTANCE

资源类型定义。

Page Integer 1

页数。

NextToken String 1d2db86sca4384811e0b5e8707e******

下一个查询开始的Token。

Size Integer 10

大小。

ResourceIds String ["es-cn-aaa","es-cn-bbb"]

要查询的实例ID列表。

Tags String [{"key":"env","value","dev"},{"key":"dev", "value":"IT"}]

要查询的tag列表,采用JSON字符串的形式,最多包含20个子项限制。

  • 参数ResourceIdsTags二者需要选一个传入,否则提示异常信息。
  • 用户查询结果仅为可见标签,不可见标签无法查询。

返回数据

名称 类型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6D******

当前请求的Request ID。

PageSize Integer 1

分页数。

Headers Struct

返回头信息。

X-Total-Count Integer 10

查询到TagResource的资源数量。

TagResources Struct

标签资源组。

TagResource Array

标签资源。

resourceId String es-cn-0xl0d06q9000b*****

实例ID。

resourceType String ALIYUN::ELASTICSEARCH::INSTANCE

资源类型。

tagKey String env

标签键。

tagValue String dev

标签值。

示例

请求示例

GET /consoleapi/tags?
ResourceIds=["es-cn-0xl0d06q9000b****","es-cn-xxx"]
&ResourceType=INSTANCE
&Tags=[{"key":"env","value":"dev"},{"key":"dep","value":"IT"}]

正常返回示例

XML 格式

<RequestId>3D8795D9-8FF5-46B2-86E6-E3B4073169BE</RequestId>
<TagResources>
    <TagResource>
        <ResourceType>ALIYUN::ELASTICSEARCH::INSTANCE</ResourceType>
        <ResourceId>es-cn-0xl0d06q9000****</ResourceId>
        <TagKey>env</TagKey>
        <TagValue>dev</TagValue>
    </TagResource>
</TagResources>

JSON 格式

{
    "RequestId": "3D8795D9-8FF5-46B2-86E6-E3B4073169BE",
    "TagResources": {
        "TagResource": [
            {
                "ResourceType": "ALIYUN::ELASTICSEARCH::INSTANCE",
                "ResourceId": "es-cn-0xl0d06q9000****",
                "TagKey": "env",
                "TagValue": "dev"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
401 UserUnauthorized Authentication required 用户验证失败,请先登录并核对是否有权限
401 SubAccountNoPermission Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM 子账户无权限,请核对子账号权限

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