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

调试

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

请求参数

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

系统规定参数。取值:OnsInstanceInServiceList

Tag.N.Key String CartService

资源的标签键。

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

资源的标签值。

  • N 的取值范围为 1~20。
  • 一旦传入该值,可以为空字符串。
  • 最多支持 128 个字符,不能以 aliyun 和 acs: 开头,不能包含 http://或者 https://。

返回数据

名称 类型 示例值 描述
Data Array of InstanceVO

返回所有已发布的实例信息列表。

InstanceVO
IndependentNaming Boolean true

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

  • true:拥有独立命名空间,资源命名确保实例内唯一,跨实例之间可重名。
  • false:无独立命名空间,实例内或者跨实例之间,资源命名必须全局唯一。
InstanceId String MQ_INST_188077086902****_BXSuW61e

实例 ID。

InstanceName String test1

实例名称。

长度限制 3~64 个字符,可以是中文、英文、数字、短划线(-)以及下划线(_)。

InstanceStatus Integer 5

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

  • 0:铂金版实例部署中
  • 2:后付费实例已欠费
  • 5:后付费实例或铂金版实例服务中
  • 7:铂金版实例升级中且服务可用
InstanceType Integer 2

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

  • 1:后付费实例
  • 2:铂金版实例
ReleaseTime Long 1551024000000

铂金版实例的过期时间。

Tags Array of Tag

实例所绑定的标签。

Tag
Key String CartService

标签键。

Value String ServiceA

标签值。

RequestId String 0598E46F-DB06-40E2-AD7B-C45923EE****

公共参数,每个请求的 ID 都是唯一的。

示例

请求示例

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

正常返回示例

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 格式

{
        "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"
                    }
                ]
            }
        }
    ]
}
}

错误码

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