调用ListInstances获取数据集加速实例列表_人工智能平台 PAI(PAI)-阿里云帮助中心

获取数据集加速实例信息列表。

接口说明

请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
datasetacc:ListInstances	Read	全部资源 acs:datasetacc:{#regionId}:{#accountId}:*	无	无

请求语法

GET /api/v1/instances

请求参数

名称	类型	必填	描述	示例值
InstanceIds	string	否	实例 ID 的列表，多个加速实例 ID 间，以半角逗号（,）分隔。	inst-my1tk3jggooi5uwks5, inst-n69468yvjz8d12as7d, inst-tga4omjrepklkg1onn
Name	string	否	实例名称，支持模糊匹配。	acc_instance_1
Type	string	否	数据集加速实例的类型，参考：产品规格，取值如下： basic：基础版。 enhanced：增强版。	basic
PaymentType	string	否	数据集加速实例的付费类型，取值如下： PayAsYouGo：后付费（按量付费）。 Subscription：预付费（包年包月）。	PayAsYouGo
Phase	string	否	数据集加速实例所处状态，取值如下： Created：初始化。 Running：运行中。 Stopped：已停止。	Running
SortBy	string	否	排序字段。	GmtCreateTime
Order	string	否	排列顺序，取值如下： Desc：降序排列。 Asc：升序排列。	Desc
PageNumber	integer	否	数据集加速实例列表的页码。起始值为 1，默认为 1。	1
PageSize	integer	否	分页查询时设置的每页显示的数据集加速实例的数量，默认为 10。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	A731A84D-55C9-44F7-99BB-E1CF0CF19197
Instances	object []	数据集加速实例列表。
UserId	string	数据集加速实例的创建者的 Uid，在阿里云内为 RAM 用户 ID（阿里云账号创建则直接为阿里云账号 ID）。	276065346797410278
OwnerId	string	数据集加速实例资源拥有者的 Uid，在阿里云内为阿里云账号 ID。	1557702098194904
GmtCreateTime	string	数据集加速实例创建的时间。格式使用 ISO8601（RFC3339）。	2014-10-02T15:01:23Z
GmtModifiedTime	string	数据集加速实例最后更新的时间。格式使用 ISO8601（RFC3339）。	2014-10-02T15:01:23Z
Uuid	string	数据集加速实例的唯一标识符。	inst-my1tk3jggooi5uwks5
Name	string	数据集加速实例名称。	acc_instance_1
Description	string	数据集加速实例的描述与解释。	xgboost数据集加速实例
Type	string	数据集加速实例的类型，可能值： Basic：基础版。 Advanced：进阶版。 Express：极速版。	Basic
Tags	object []	用户为数据集加速实例添加的自定义标签。
Key	string	标签的键值。长度限制为 64 Unicode 字符。	dataset_version
Value	string	标签的值。长度限制为 64 Unicode 字符。	v0.1.0
PaymentType	string	数据集加速实例的付费类型，可能值： PayAsYouGo：后付费（按量付费）。 Subscription：预付费（包年包月）。	PayAsYouGo
Capacity	string	数据集加速实例的最大容量。输入字符串的格式需要满足以下规范： Quantity 。	30.0G
IoType	string	数据集加速实例的读写类型。	readonly
MaxSlot	integer	数据集加速实例的最大加速槽个数。	20
MaxEndpoint	integer	数据集加速实例的最大挂载点个数。
StorageType	string	数据集加速实例的存储类型。	OSS
ProviderType	string	数据集加速实例的资源提供者类型。	Ecs
Status	InstanceStatus	数据集加速实例状态。
TotalCount	integer	列表内元素数量总和。	100

示例

正常返回示例

JSON格式

{
  "RequestId": "A731A84D-55C9-44F7-99BB-E1CF0CF19197",
  "Instances": [
    {
      "UserId": "276065346797410278",
      "OwnerId": "1557702098194904",
      "GmtCreateTime": "2014-10-02T15:01:23Z",
      "GmtModifiedTime": "2014-10-02T15:01:23Z",
      "Uuid": "inst-my1tk3jggooi5uwks5",
      "Name": "acc_instance_1",
      "Description": "xgboost数据集加速实例",
      "Type": "Basic",
      "Tags": [
        {
          "Key": "dataset_version",
          "Value": "v0.1.0"
        }
      ],
      "PaymentType": "PayAsYouGo",
      "Capacity": "30.0G",
      "IoType": "readonly",
      "MaxSlot": 20,
      "MaxEndpoint": 0,
      "StorageType": "OSS",
      "ProviderType": "Ecs",
      "Status": {
        "Phase": "Running",
        "Code": "200",
        "Message": "Init Succeed",
        "UsedCapacity": "20.0G",
        "SlotNum": 10
      }
    }
  ],
  "TotalCount": 100
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-05-22

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-05-22

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。