调用OnsInstanceInServiceList查询当前账号在某地域（Region）下所有实例的信息。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

授权信息

默认仅限阿里云账号使用本接口，RAM用户需要根据该接口访问的实例是否命名空间决定是否需要授权。更多信息，请参见权限策略和示例。

  • 若实例无命名空间，则RAM用户调用该接口无需被授予任何权限。
  • 若API访问资源所属的实例有命名空间，则RAM用户调用OnsInstanceInServiceList接口时必须先被授予实例的mq:QueryInstanceBaseInfo权限，否则调用该接口查询不到任何信息。授权信息如下表所示。

API

Action

Resource

OnsInstanceInServiceList

mq:QueryInstanceBaseInfo

acs:mq:*:*:{instanceId}

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 OnsInstanceInServiceList

系统规定参数。取值：OnsInstanceInServiceList。

Tag.N.Key String 是 CartService

实例的标签键。Key和Value值必须同时输入或同时不输入。若同时输入表示根据Tag过滤符合条件的实例，若不输入表示查询所有实例。

  • N的取值范围为1~20。
  • 如果输入该值，则取值不允许为空字符串。
  • 最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
Tag.N.Value String 是 SericeA

资源的标签值。Key和Value值必须同时输入或同时不输入。若同时输入表示根据Tag过滤符合条件的实例，若不输入表示查询所有实例。

  • N的取值范围为1~20。
  • 如果输入该值，取值允许为空字符串。
  • 最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。

返回数据

名称 类型 示例值 描述
RequestId String 0598E46F-DB06-40E2-AD7B-C45923EE****

公共参数，每个请求的ID都是唯一的，可用于排查和定位问题。
Data Array of InstanceVO

返回所有已发布的实例信息列表。
InstanceVO
IndependentNaming Boolean true

实例是否有命名空间。取值说明如下：

  • true：拥有独立命名空间，资源命名确保实例内唯一，跨实例之间可重名。
  • false：无独立命名空间，实例内或者跨实例之间，资源命名必须全局唯一。
InstanceName String test1

实例名称。

长度限制3~64个字符，可以是中文、英文、数字、短划线（-）以及下划线（_）。
ReleaseTime Long 1551024000000

铂金版实例的过期时间。
InstanceStatus Integer 5

实例状态。取值说明如下：

  • 0：铂金版实例部署中
  • 2：标准版实例已欠费
  • 5：标准版实例或铂金版实例服务中
  • 7：铂金版实例升级中且服务可用
Tags Array of Tag

实例所绑定的标签。
Tag
Key String CartService

标签键。
Value String ServiceA

标签值。
InstanceId String MQ_INST_188077086902****_BXSuW61e

实例ID。
InstanceType Integer 2

实例类型。取值说明如下：

  • 1：标准版实例
  • 2：铂金版实例

各类型实例的规格和差异说明，请参见实例规格。

示例

请求示例

http(s)://ons.cn-zhangjiakou.aliyuncs.com/?Action=OnsInstanceInServiceList
&Tag.1.Key=CartService
&Tag.1.Value=SericeA
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsInstanceInServiceListResponse>
<RequestId>0598E46F-DB06-40E2-AD7B-C45923EE****</RequestId>
<Data>
    <InstanceVO>
        <InstanceName>test1</InstanceName>
        <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>
        <ReleaseTime>1551024000000</ReleaseTime>
        <InstanceStatus>5</InstanceStatus>
        <IndependentNaming>true</IndependentNaming>
        <InstanceType>2</InstanceType>
        <Tags>
            <Tag>
                <Value>ServiceA</Value>
                <Key>CartService</Key>
            </Tag>
        </Tags>
    </InstanceVO>
</Data>
</OnsInstanceInServiceListResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0598E46F-DB06-40E2-AD7B-C45923EE****",
  "Data" : {
    "InstanceVO" : [ {
      "InstanceName" : "test1",
      "InstanceId" : "MQ_INST_188077086902****_BXSuW61e",
      "ReleaseTime" : 1551024000000,
      "InstanceStatus" : 5,
      "IndependentNaming" : true,
      "InstanceType" : 2,
      "Tags" : {
        "Tag" : [ {
          "Value" : "ServiceA",
          "Key" : "CartService"
        } ]
      }
    } ]
  }
}

错误码

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