ListTagResources - 查询标签

更新时间:

查询标签。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

mq:ListTagResources

list

*全部资源

*

  • mq:MqttInstanceAccess

请求参数

名称

类型

必填

描述

示例值

ResourceType

string

资源类型。唯一取值为 instance。

instance

ResourceId

array

资源 ID 列表。

string

要查询资源 ID,目前只支持实例,ResourceId 和 Tag 不能同时为空。

mqtt-cn-5yd3xxx

Tag

array<object>

资源标签列表,ResourceId 和 Tag 不能同时为空。

object

标签对象。

Key

string

标签键。

test

Value

string

标签值。

test

NextToken

string

下一个查询开始 Token。

AAAAAaFXUH1VTHnBlds7StUakOQ=

返回参数

名称

类型

描述

示例值

object

返回对象。

RequestId

string

Id of the request

34063BCA-0946-49C1-B824-2ED2C905****

Code

string

响应 code。

200

Message

string

信息

operation success.

Success

string

请求是否成功。

true

NextToken

string

下一个查询开始 Token。

AAAAAaFXUH1VTHnBlds7StUakOQ=

TagResources

array<object>

资源和标签的关系列表。

object

TagResource 对象。

ResourceType

string

资源类型。唯一取值为 instance。

instance

TagValue

string

标签值。

test

ResourceId

string

资源 ID。

mqtt-cn-5yd3xxx

TagKey

string

标签键。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "34063BCA-0946-49C1-B824-2ED2C905****",
  "Code": "200",
  "Message": "operation success.",
  "Success": "true",
  "NextToken": "AAAAAaFXUH1VTHnBlds7StUakOQ=",
  "TagResources": [
    {
      "ResourceType": "instance",
      "TagValue": "test",
      "ResourceId": "mqtt-cn-5yd3xxx\n",
      "TagKey": "test"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 MqttOwnerCheckError Failed to validate the instance permission 实例权限校验失败
400 ResourceIdNotFound resourceId does not exist. 标签资源不存在
403 PermissionCheckFailed Failed to verify API permissions. ram权限检查失败

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

变更历史

更多信息,参考变更详情