ListInstances - 获取实例列表

获取实例列表。

调试

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

授权信息

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

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

请求语法

GET /api/v1/instances HTTP/1.1

请求参数

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

页码,起始值为 1,默认值为 1。

1
PageSizeinteger

页大小,默认为 10。

10
Statusstring

状态过滤。 ● Initializing-初始化中。 ● Running-运行中。 ● Failure-创建失败。

Running
SortBystring

排序依据。 ● GmtCreateTime-创建时间。 ● GmtModifiedTime-更新时间。

GmtCreateTime
Orderstring

排序方式。 ● ASC-升序。 ● DESC-降序。

DESC

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

2CA11923-2A3D-5E5A-8314-E699D2DD15DE
TotalCountlong

总个数。

10
Instancesarray<object>

实例列表。

Instancesobject
InstanceIdstring

实例 ID。

featureStore-cn-7mz2xfu****
Typestring

实例类型,目前仅支持 Basic(基础版)。

Basic
Statusstring

状态。

● Initializing-初始化中。

● Running-运行中。

● Stopped-停止服务。

Initializing
RegionIdstring

所属区域。

● cn-hangzhou

● cn-beijing

● cn-shanghai

● cn-shenzhen

cn-hangzhou
GmtCreateTimestring

创建时间。

2023-07-04T11:26:09.036+08:00
GmtModifiedTimestring

更新时间。

2023-07-04T11:26:09.036+08:00
FeatureDBInstanceInfoobject

FeatureDB 实例信息

Statusstring

状态。

示例

正常返回示例

JSON格式

{
  "RequestId": "2CA11923-2A3D-5E5A-8314-E699D2DD15DE",
  "TotalCount": 10,
  "Instances": [
    {
      "InstanceId": "featureStore-cn-7mz2xfu****",
      "Type": "Basic",
      "Status": "Initializing",
      "RegionId": "cn-hangzhou",
      "GmtCreateTime": "2023-07-04T11:26:09.036+08:00",
      "GmtModifiedTime": "2023-07-04T11:26:09.036+08:00",
      "FeatureDBInstanceInfo": {
        "Status": ""
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-28OpenAPI 入参发生变更查看变更详情