ListInstances - 列表查询EIAM实例

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eiam:ListInstancesget
*Instance
acs:eiam:{#regionId}:{#accountId}:instance/*

请求参数

名称类型必填描述示例值
PageNumberlong

列表页码。

1
PageSizelong

列表大小。

20
InstanceIdsarray

实例 ID 列表。

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
Statusstring

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

  • creating:创建中。
  • running:运行中。
running

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

列表总条数目。

100
Instancesarray<object>

实例信息列表。

Instanceobject

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

InstanceIdstring

实例 ID。

idaas_eypq6ljgyeuwmlw672sulxxxxx
CreateTimelong

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

1550115455000
Statusstring

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

  • creating:创建中。
  • running:运行中。
running
Descriptionstring

实例描述信息。

正式环境
DefaultEndpointobject

实例默认域名。

Endpointstring

实例域名地址。

example-xxx.aliyunidaas.com
Statusstring

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

  • resolved:已解析。
  • unresolved:未解析。
resolved

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Instances": [
    {
      "InstanceId": "idaas_eypq6ljgyeuwmlw672sulxxxxx",
      "CreateTime": 1550115455000,
      "Status": "running",
      "Description": "正式环境",
      "DefaultEndpoint": {
        "Endpoint": "example-xxx.aliyunidaas.com\n",
        "Status": "resolved"
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史