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

QPS限制

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

授权信息

阿里云账号和RAM用户调用该接口,均不需要进行授权。更多信息,请参见权限策略和示例

请求参数

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

系统规定参数。取值:OnsInstanceInServiceList

Tag.N.Key String CartService

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

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

资源的标签值。KeyValue值必须同时输入或同时不输入。若同时输入表示根据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"
        } ]
      }
    } ]
  }
}

错误码

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