文档

ListInstance - 查询实例列表

更新时间:

调用该接口查询实例列表。

调试

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

授权信息

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

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

请求参数

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

实例名称。

test
InstanceStatusstring

实例状态,取值:

  • PENDING:初始化中。

  • INIT_ERROR:初始化失败。

  • STARTING:启动中。

  • RUNNING:运行中。

  • STOPPING:停止中。

  • STOPPED:已停止。

  • DELETING:删除中。

  • DELETED:已删除。

RUNNING
PageNointeger

页号。

1
PageSizeinteger

页大小。

30
ResourceGroupIdstring

资源组 ID。

rg-acfmv36i4is****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

A2A9BA68-B264-4953-9154-CE61B1C03BA6
Codestring

返回值。

success
PageNointeger

页号,默认值 1。

1
IsSuccessboolean

是否成功。

true
PageSizeinteger

页大小,默认值 30。

30
TotalCountinteger

返回结果数量。

12121
Instancesobject []

实例信息。

ModifiedTimestring

最近修改时间。

1562849760000
InstanceNamestring

实例名。

test
CreateTimestring

创建时间。

1562849679000
InstanceSpecificationstring

企业版规格。

Enterprise_Basic
InstanceStatusstring

实例状态。

RUNNING
InstanceIdstring

实例 ID。

cri-sgedpenzw80e****
RegionIdstring

区域 ID。

cn-shanghai
ResourceGroupIdstring

资源组 ID。

rg-aek2h3aexpy****
InstanceIssuestring

实例问题。

oss bucket already exists
Tagsobject []
TagKeystring

标签键

TagValuestring

标签值

示例

正常返回示例

JSON格式

{
  "RequestId": "A2A9BA68-B264-4953-9154-CE61B1C03BA6",
  "Code": "success",
  "PageNo": 1,
  "IsSuccess": true,
  "PageSize": 30,
  "TotalCount": 12121,
  "Instances": [
    {
      "ModifiedTime": "1562849760000",
      "InstanceName": "test",
      "CreateTime": "1562849679000",
      "InstanceSpecification": "Enterprise_Basic",
      "InstanceStatus": "RUNNING",
      "InstanceId": "cri-sgedpenzw80e****",
      "RegionId": "cn-shanghai",
      "ResourceGroupId": "rg-aek2h3aexpy****",
      "InstanceIssue": "oss bucket already exists",
      "Tags": [
        {
          "TagKey": "",
          "TagValue": ""
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息
403NoPrivilegeAccess denied for this user.
500SystemErrorUnknown error.

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

变更历史

变更时间变更内容概要操作
2023-06-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)