文档

QueryInstanceByTag - 按标签查询实例

更新时间:
一键部署

根据标签信息查询实例列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bssapi:QueryInstanceByTagRead
  • 全部资源
    *

请求参数

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

资源类型 instance 节省计划实例

instance
ResourceIdarray

资源 id 列表

string

资源 ID

spn-XXXXXX
Tagobject []

标签列表

Keystring

标签键

ecs
Valuestring

标签值

001

返回参数

名称类型描述示例值
object

返回值

Codestring

状态码

PARAM_ERROR
Messagestring

错误信息

param is null
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

CAESEgoQCg4KCm
RequestIdstring

请求 ID

9EC6C0B7-3397-5FAE-9915-8972CDDB1211
Successboolean

是否成功

true
TagResourceobject []

实例信息的列表

ResourceIdstring

资源 ID

spn-xxxxx
ResourceTypestring

资源类型 instance 节省计划实例

instance
Tagobject []

标签列表

Keystring

标签键

tag1
Valuestring

标签值

10

示例

正常返回示例

JSON格式

{
  "Code": "PARAM_ERROR",
  "Message": "param is null",
  "NextToken": "CAESEgoQCg4KCm",
  "RequestId": "9EC6C0B7-3397-5FAE-9915-8972CDDB1211",
  "Success": true,
  "TagResource": [
    {
      "ResourceId": "spn-xxxxx",
      "ResourceType": "instance",
      "Tag": [
        {
          "Key": "tag1",
          "Value": "10"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈