ListInstances - 列表查询EIAM实例

更新时间:
复制 MD 格式

查询一个或者多个EIAM实例信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

列表页码。

1

PageSize

integer

列表大小。

20

InstanceIds

array

实例 ID 列表。

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

Status

string

实例状态,取值可选范围:

  • creating:创建中。

  • running:运行中。

running

Edition

string

License 的版本型号,取值可选范围:

  • free:免费版。

  • trial:试用版。

  • scalability:能力扩展版。

  • standard:标准版。

  • enterprise:企业版。

free

CrossRegionReplication

string

跨 Region 复制状态

disabled

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

TotalCount

integer

列表总条数目。

100

Instances

array<object>

实例信息列表。

array<object>

由 Instances 组成的数组格式,返回实例的信息。

InstanceId

string

实例 ID。

idaas_eypq6ljgyeuwmlw672sulxxxxx

CreateTime

integer

实例创建时间,Unix 时间戳格式,单位为毫秒。

1550115455000

Status

string

实例状态,取值可选范围:

  • creating:创建中。

  • running:运行中。

running

Description

string

实例描述信息。

instance_for_test

DefaultEndpoint

object

实例默认域名。

Endpoint

string

实例域名地址。

example-xxx.aliyunidaas.com

Status

string

实例域名状态,取值可选范围:

  • resolved:已解析。

  • unresolved:未解析。

resolved

ServiceManaged

boolean

实例是否被云产品托管

true

ManagedServiceCode

string

托管实例的云产品 ServiceCode

sase

CrossRegionReplication

string

跨 region 复制是否开启,取值:enabled 或 disabled

enabled

CrossRegionReplicationRole

string

跨 region 复制角色,primary 表示主实例,backup 表示备实例

primary

InstanceFailoverStatus

string

实例故障转移激活状态,active 表示激活,inactive 表示未激活

inactive

ReplicationConfiguration

object

当 CrossRegionReplication 为 enabled 的时候有值

ReplicationCreateTime

integer

灾备数据复制创建时间,Unix 时间戳格式,单位为毫秒

1778499337000

PrimaryInstanceId

string

主实例 ID

idaas_xxxxxx

PrimaryInstanceRegionId

string

主实例 RegionID

cn-hangzhou

BackupInstanceId

string

灾备实例 ID

idaas_xxxxxx

BackupInstanceRegionId

string

灾备 RegionID

cn-beijing

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Instances": [
    {
      "InstanceId": "idaas_eypq6ljgyeuwmlw672sulxxxxx",
      "CreateTime": 1550115455000,
      "Status": "running",
      "Description": "instance_for_test",
      "DefaultEndpoint": {
        "Endpoint": "example-xxx.aliyunidaas.com\n",
        "Status": "resolved"
      },
      "ServiceManaged": true,
      "ManagedServiceCode": "sase",
      "CrossRegionReplication": "enabled",
      "CrossRegionReplicationRole": "primary",
      "InstanceFailoverStatus": "inactive",
      "ReplicationConfiguration": {
        "ReplicationCreateTime": 1778499337000,
        "PrimaryInstanceId": "idaas_xxxxxx",
        "PrimaryInstanceRegionId": "cn-hangzhou",
        "BackupInstanceId": "idaas_xxxxxx",
        "BackupInstanceRegionId": "cn-beijing"
      }
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情