调用QueryInstanceByTag按标签查询实例_阿里云交易和账单管理API(BOA)-阿里云帮助中心

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
bssapi:QueryInstanceByTag	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ResourceType	string	是	资源类型 instance 节省计划实例	instance
ResourceId	array	否	资源 id 列表
	string	否	资源 ID	spn-XXXXXX
Tag	object []	否	标签列表
Key	string	否	标签键	ecs
Value	string	否	标签值	001

返回参数

名称	类型	描述	示例值
	object	返回值
Code	string	状态码	PARAM_ERROR
Message	string	错误信息	param is null
NextToken	string	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	CAESEgoQCg4KCm
RequestId	string	请求 ID	9EC6C0B7-3397-5FAE-9915-8972CDDB1211
Success	boolean	是否成功	true
TagResource	object []	实例信息的列表
ResourceId	string	资源 ID	spn-xxxxx
ResourceType	string	资源类型 instance 节省计划实例	instance
Tag	object []	标签列表
Key	string	标签键	tag1
Value	string	标签值	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"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史