ListInstances - 获取实例列表_人工智能平台 PAI(PAI)-阿里云帮助中心

获取实例列表。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
featurestore:ListInstances	list	全部资源 ``	无	无

请求语法

GET /api/v1/instances HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	页码，起始值为 1，默认值为 1。	1
PageSize	integer	否	页大小，默认为 10。	10
Status	string	否	状态过滤。 Initializing：初始化中 Running：运行中 Failure：创建失败	Running
SortBy	string	否	排序依据。 GmtCreateTime：创建时间 GmtModifiedTime：更新时间	GmtCreateTime
Order	string	否	排序方式。 ASC：升序 DESC：降序	DESC

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	2CA11923-2A3D-5E5A-8314-E699D2DD15DE
TotalCount	long	总个数。	10
Instances	array<object>	实例列表。
Instances	object
InstanceId	string	实例 ID。	featureStore-cn-7mz2xfu****
Type	string	实例类型，目前仅支持 Basic（基础版）。	Basic
Status	string	状态。 Initializing：初始化中 Running：运行中 Stopped：停止服务	Initializing
RegionId	string	所属区域。 cn-hangzhou cn-beijing cn-shanghai cn-shenzhen	cn-hangzhou
GmtCreateTime	string	创建时间。	2023-07-04T11:26:09.036+08:00
GmtModifiedTime	string	更新时间。	2023-07-04T11:26:09.036+08:00
FeatureDBInstanceInfo`deprecated`	object	FeatureDB 实例信息
Status	string	状态。
FeatureDBInfo	object	FeatureDB 实例信息。
Status	string	状态。

示例

正常返回示例

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": ""
      },
      "FeatureDBInfo": {
        "Status": ""
      }
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-16	OpenAPI 返回结构发生变更	查看变更详情
2023-08-28	OpenAPI 入参发生变更	查看变更详情