ListSlots - 获取数据集加速槽列表

更新时间: 2023-08-11 10:49:11

获取数据集加速槽的信息列表。

接口说明

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

调试

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

调试

授权信息

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

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

请求语法

GET /api/v1/slots

请求参数

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

数据集加速槽ID的列表,多个加速槽ID以半角逗号(,)分隔。

slot-my1tk3jggooi5u****,slot-n69468yvjz8d12****,slot-tga4omjrepklkg****
InstanceIdsstring

加速槽所对应的数据集加速实例的唯一标识符。如何获取加速实例ID,请参见ListInstances

inst-my1tk3jggooi5u****
Namestring

数据集加速槽名称,支持模糊匹配。

acc_instance_slot_1
StorageTypestring

数据集加速槽的数据存储类型,取值如下:

  • OSS:OSS文件存储。
  • NAS:NAS文件存储。
OSS
Phasestring

数据集加速槽所处状态,取值如下:

  • Created:已创建。
  • Preparing:正在准备资源。
  • Loading:正在加载数据。
  • Running:正在运行,提供服务。
  • Reloading:正在重新加载数据。
  • Succeed:成功完成。
  • Failed:已失败。
  • Stopping:正在停止。
  • Stopped:已停止。
Running
SortBystring

排序字段。

GmtCreateTime
Orderstring

排列顺序,取值如下:

  • Desc: 降序排列。
  • Asc: 升序排列。
Desc
PageNumberinteger

加速槽列表的页码。起始值为1,默认为1。

1
PageSizeinteger

分页查询时设置的每页显示的加速槽数量,默认为10。

10
EndpointIdsstring

加速槽所对应的数据集加速挂载点的唯一标识符。

endp-my1tk3jggooi5uwks5
StorageUristring

数据集加速槽的数据存储路径(URI)。

返回参数

名称类型描述示例值
object

返回值。

RequestIdstring

请求ID。

A731A84D-55C9-44F7-99BB-E1CF0CF1****
Slotsobject []

数据集加速列表。

UserIdstring

数据集加速槽的创建者的Uid,在阿里云内为RAM用户ID(阿里云账号创建则直接为阿里云账号ID)。

27606534679741****
OwnerIdstring

数据集加速槽资源拥有者的Uid,在阿里云内为阿里云账号ID。

155770209819****
GmtCreateTimestring

数据集加速槽创建的时间。格式使用ISO8601(RFC3339)。

2014-10-02T15:01:23Z
GmtModifiedTimestring

数据集加速槽最后更新的时间。格式使用ISO8601(RFC3339)。

2014-10-02T15:01:23Z
Uuidstring

数据集加速槽的唯一标识符。

slot-5zk866779me51j****
InstanceIdstring

加速槽所对应的数据集加速实例的唯一标识符。

inst-my1tk3jggooi5u****
Namestring

数据集加速槽名称。

slot_1
Descriptionstring

数据集加速槽的描述与解释。

xgboost数据集加速槽
Tagsobject []

用户为数据集加速槽添加的自定义标签。

Keystring

标签的键值。

dataset_version
Valuestring

标签的值。

v0.1.0
StorageTypestring

数据集加速槽的数据存储类型,可能值:

  • OSS:OSS文件存储。
  • NAS:NAS文件存储。
OSS
StorageUristring

数据集加速槽的数据的资源标识符,数据类型不同存在不同格式。

oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt
Capacitystring

数据集加速槽的最大容量。输入字符串的格式需要满足以下规范:Quantity

30.0G
IoTypestring

数据集加速槽的读写类型。

readonly
LifeCycleSlotLifeCycle

数据集加速槽的生命周期。

StatusSlotStatus

数据集加速槽状态。

Endpointsobject []

数据集加速槽关联的端点列表。

UserIdstring

数据集加速端点的创建者的Uid,在阿里云内为RAM用户ID(阿里云账号创建则直接为阿里云账号ID)。

27606534679741****
OwnerIdstring

数据集加速端点的资源拥有者的Uid,在阿里云内为阿里云账号ID。

155770209819****
GmtCreateTimestring

数据集加速端点创建的时间。格式使用ISO8601(RFC3339)。

2014-10-02T15:01:23Z
GmtModifiedTimestring

数据集加速端点最后更新的时间。格式使用ISO8601(RFC3339)。

2014-10-02T15:01:23Z
Uuidstring

挂载点的唯一标识符。

end-ivrq92qhbyrg4j****
Namestring

挂载点的名称。

endpoint-1
Typestring

挂载点的网络类型,可能值:

  • VPC:挂载点处于VPC网络。
  • INNER:挂载点处于PAI内部网络中,用于PAI其他产品进行访问。
VPC
VpcIdstring

挂载点使用的专有网络 VPC ID。

vpc-j6co2fcdsl1q0gnuc****
VswitchIdstring

挂载点使用的交换机vSwitch ID。

vsw-j6cmr00qjyrft6jo2****
StatusEndpointStatus

数据集加速槽挂载点的状态。

TotalCountinteger

列表内元素数量总和。

100

示例

正常返回示例

JSON格式

{
  "RequestId": "A731A84D-55C9-44F7-99BB-E1CF0CF1****",
  "Slots": [
    {
      "UserId": "27606534679741****",
      "OwnerId": "155770209819****",
      "GmtCreateTime": "2014-10-02T15:01:23Z",
      "GmtModifiedTime": "2014-10-02T15:01:23Z",
      "Uuid": "slot-5zk866779me51j****",
      "InstanceId": "inst-my1tk3jggooi5u****",
      "Name": "slot_1",
      "Description": "xgboost数据集加速槽",
      "Tags": [
        {
          "Key": "dataset_version",
          "Value": "v0.1.0"
        }
      ],
      "StorageType": "OSS",
      "StorageUri": "oss://examplebucket/data/VOCdevkit/VOC2007/ImageSets/Main/val.txt",
      "Capacity": "30.0G",
      "IoType": "readonly",
      "LifeCycle": {
        "Type": "KeepAlive",
        "Config": "{}"
      },
      "Status": {
        "Phase": "Running",
        "Code": "200",
        "Message": "Init Succeed",
        "Detail": {
          "LoadedFileNum": 1000000,
          "LoadedFileSize": "200G",
          "LoadingTimeCost": 1800000
        }
      },
      "Endpoints": [
        {
          "UserId": "27606534679741****",
          "OwnerId": "155770209819****",
          "GmtCreateTime": "2014-10-02T15:01:23Z",
          "GmtModifiedTime": "2014-10-02T15:01:23Z",
          "Uuid": "end-ivrq92qhbyrg4j****",
          "Name": "endpoint-1",
          "Type": "VPC",
          "VpcId": "vpc-j6co2fcdsl1q0gnuc****",
          "VswitchId": "vsw-j6cmr00qjyrft6jo2****",
          "Status": {
            "Phase": "Ready",
            "Code": "200",
            "Message": "Init Succeed",
            "Detail": {
              "IpPortMapping": {
                "key": {
                  "Ip": "10.0.0.5",
                  "Port": "3306"
                }
              }
            }
          }
        }
      ]
    }
  ],
  "TotalCount": 100
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-22OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:EndpointIds
    新增入参:StorageUri
阿里云首页 机器学习平台 PAI 相关技术圈