首页 机器学习PAI API参考 PAI-AI WorkSpace API目录 工作空间 ListResources - 获取工作空间的资源列表

ListResources - 获取工作空间的资源列表

获取工作空间内已关联的资源列表。

调试

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

调试

授权信息

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

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

请求参数

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

工作空间ID。

  • 对于ListResourceByWorkspace,该参数必填
  • 对于ListResource,该参数不能填入
123
PageNumberlong

分页编号,从1开始,默认为1。

1
PageSizeinteger

分页大小,默认为20。

20
ProductTypesstring

资源类型列表,以逗号分隔,可选值 MaxCompute,DLC,FLINK。

MaxCompute
GroupNamestring

资源分组名。 通过ListResources获取Resource的GroupName。

group
ResourceNamestring

资源名。

resource
Optionstring

选项,目前支持

  • ListResourceByWorkspace(默认值):获取工作空间的资源列表
  • ListResource:获取用户的资源列表
ListResourceByWorkspace
Verboseboolean
  • true:代表展示详细信息(默认值),目前详细信息包含如下字段:Quotas
  • false:代表不展示详细信息
true

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求ID。

1e195c5116124202371861018d5bde
Resourcesarray

资源列表。

object

资源信息。

Idstring

资源ID。

123
Namestring

资源名,长度需要在3到28个字符,region内唯一。

ResourceName
ProductTypestring

资源类型, 支持:

  • MaxCompute:大数据计算服务资源
  • DLC:云原生资源
  • FLINK:Flink资源
MaxCompute
EnvTypestring

环境, 支持dev(开发)、prod(生产)。

prod
WorkspaceIdstring

所属的工作空间ID。

123
IsDefaultboolean

是否默认资源,每种资源类型都有一个默认的资源。

true
Quotasarray

配额列表

object

配额信息

Namestring

配额名称

QuotaName
ProductCodestring

产品名,支持如下值

  • PAI_isolate:pai预付费资源组(pai cpu)
  • PAI_share:pai后付费资源组(pai gpu)
  • MaxCompute_share:MaxCompute后付费资源组
  • MaxCompute_isolate:MaxCompute预付费资源组
  • DataWorks_isolate:Dataworks预付费资源组
  • DataWorks_share:Dataworks后付费资源组
  • DLC_share:DLC后付费资源组
MaxCompute_isolate
QuotaTypestring

资源配额类型, 支持如下值

  • PAI
  • MaxCompute
  • DLC
MaxCompute
Modestring

付费模式:

  • isolate:预付费
  • share:后付费
develop
Specsarray

规格描述列表

object

规格描述信息

Namestring

规格名字

cu
Valuestring

规格描述

11500
CardTypestring

卡类型,支持

  • CPU
  • GPU
cpu
Idstring

资源配额ID。

123
DisplayNamestring

资源配额别名。

默认后付费Quota
Specobject

规格说明。

GroupNamestring

分组名,主账户内唯一。

groupName
GmtCreateTimestring

创建 UTC 时间,日期格式 iso8601

2021-01-21T17:12:35.232Z
TotalCountlong

符合过滤条件的数量。

2

示例

正常返回示例

JSON格式

{
  "RequestId": "1e195c5116124202371861018d5bde",
  "Resources": [
    {
      "Id": "123",
      "Name": "ResourceName",
      "ProductType": "MaxCompute",
      "EnvType": "prod",
      "WorkspaceId": "123",
      "IsDefault": true,
      "Quotas": [
        {
          "Name": "QuotaName",
          "ProductCode": "MaxCompute_isolate",
          "QuotaType": "MaxCompute",
          "Mode": "develop",
          "Specs": [
            {
              "Name": "cu",
              "Value": "11500"
            }
          ],
          "CardType": "cpu",
          "Id": "123",
          "DisplayName": "默认后付费Quota"
        }
      ],
      "Spec": {
        "test": "test",
        "test2": 1
      },
      "GroupName": "groupName",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "Executor": {
        "key": {
          "OwnerId": ""
        }
      }
    }
  ],
  "TotalCount": 2
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-04OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-08-04OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-07-26OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Verbose
2021-03-02OpenAPI 入参发生变更,OpenAPI 返回结构发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:WorkspaceIds
    新增入参:Option
出参OpenAPI 返回结构发生变更
阿里云首页 机器学习 相关技术圈