文档

ListInstances - 获取实例列表

更新时间:

查询用户创建的所有实例列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

23D11030-3611-5648-91A5-255A379E6ABA
Instancesobject []

实例列表

InstanceIdstring

实例 ID

cmn-cn-7mz2mh3tj02
InstanceStatusstring

实例状态

RUNNING
InstanceNamestring

实例名称

实例名称
InstanceSpecstring

实例规格

profession
InstanceOpenDatestring

实例开通时间

2023-09-18 00:00:00
InstanceEndDatestring

实例到期时间

2023-10-18 00:00:00
InstanceDeviceMaxCountstring

最大纳管设备数量

100
ParentInstancestring

父实例 ID

cmn-cn-7mz2mh3tj02

示例

正常返回示例

JSON格式

{
  "RequestId": "23D11030-3611-5648-91A5-255A379E6ABA",
  "Instances": [
    {
      "InstanceId": "cmn-cn-7mz2mh3tj02",
      "InstanceStatus": "RUNNING",
      "InstanceName": "实例名称",
      "InstanceSpec": "profession",
      "InstanceOpenDate": "2023-09-18 00:00:00",
      "InstanceEndDate": "2023-10-18 00:00:00",
      "InstanceDeviceMaxCount": "100",
      "ParentInstance": "cmn-cn-7mz2mh3tj02"
    }
  ]
}

错误码

HTTP status code错误码错误信息
400SignatureDoesNotMatch签名不通过
403NoPermission没有权限
404ServiceNotFound后端服务未找到
500InternalError服务器内部错误
503ServiceUnavailable服务不可用

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

变更历史

变更时间变更内容概要操作
2023-12-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈