文档

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

更新时间:

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/resources

请求参数

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

工作空间ID。如何获取工作空间ID,请参见 ListWorkspaces

  • 对于ListResourceByWorkspace,该参数必填。
  • 对于ListResource,该参数无需配置。
123
PageNumberlong

资源列表的页码,起始值为1,默认为1。

1
PageSizeinteger

分页查询时设置的每页行数,默认为20。

20
ProductTypesstring

该字段已废弃,将会下线,请使用ResourceType字段

MaxCompute
GroupNamestring

资源分组名。如何获取资源分组名,请参见ListResources

group
ResourceNamestring

资源名。格式为:

  • 长度为3~28个字符
  • 同地域内唯一。
resource
Optionstring

选项,取值如下:

  • ListResourceByWorkspace(默认值):获取工作空间的资源列表。
  • ListResource:获取用户的资源列表。
ListResourceByWorkspace
Verboseboolean

是否展示详细信息,目前详细信息包含字段Quotas。取值如下:

  • true(默认值):表示展示详细信息。
  • false:表示不展示详细信息。
true
ResourceTypesstring

资源类型列表。取值如下:

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

QuotaId集合,用逗号分割。只有同时具有这些QuotaId的资源才会被返回。

说明 目前只有ResourceTypes=ACS的资源才支持用该参数过滤。
quota-k******da,quota-cd******w
Labelsstring

Label过滤条件集合,多个条件用逗号分隔。只有同时满足这些标签的资源才会被返回。

目前只有ProductType=ACS的资源才支持用该参数过滤。

system.supported.dsw=true,system.supported.dlc=true
VerboseFieldsstring

逗号分隔的集合,表明要返回的字段。

目前支持

  • Quota
  • Label
  • IsDefault
Quota,IsDefault

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求ID。

1e195c5116124202371861018d5bde
Resourcesobject []

资源列表。

Idstring

资源ID。

123
Namestring

资源名。

ResourceName
ProductTypestring

该字段已废弃,将会下线,请使用ResourceType字段

MaxCompute
EnvTypestring

环境类型,可能值:

  • dev:开发环境。
  • prod:生产环境。
prod
WorkspaceIdstring

所属的工作空间ID。

123
IsDefaultboolean

是否为默认资源,每种资源类型都有一个默认的资源。可能值:

  • true:是默认资源。
  • false:不是默认资源。
true
Quotasobject []

配额列表。

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:后付费。
isolate
Specsobject []

规格描述列表。

{\"cu\":\"11500\",\"minCu\":\"2300\",\"parentId\":\"0\"}
Namestring

规格名字。

cu
Valuestring

规格描述。

11500
CardTypestring

卡类型,可能值:

  • CPU
  • GPU
CPU
Idstring

资源配额ID。

123
DisplayNamestring

资源配额别名。

默认后付费Quota
Specobject

规格说明。

对于MaxCompute {"Endpoint": "odps.alibaba-inc.com", "Project": "mignshi"}
GroupNamestring

资源分组名,主账户内唯一。

groupName
GmtCreateTimestring

创建UTC时间,时间格式为ISO8601。

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

该字段无效,已废弃。

OwnerIdstring

该字段无效,已废弃。

110973******7793
Encryptionobject

加密信息,目前只对MaxCompute资源有效。

Enabledboolean

是否加密。

false
Algorithmstring

加密算法。

AESCTR
Keystring

加密主键。

DEFAULT
ResourceTypestring

资源类型,可能值:

  • MaxCompute:大数据计算服务资源。
  • DLC:云原生资源。
  • FLINK:Flink资源。
MaxCompute
Labelsobject []

标签集合。

Keystring

标签的Key。

system.supported.dsw
Valuestring

标签的Value。

true
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": "isolate",
          "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": {
        "OwnerId": "110973******7793"
      },
      "Encryption": {
        "Enabled": false,
        "Algorithm": "AESCTR",
        "Key": "DEFAULT"
      },
      "ResourceType": "MaxCompute",
      "Labels": [
        {
          "Key": "system.supported.dsw",
          "Value": "true"
        }
      ]
    }
  ],
  "TotalCount": 2
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-10-20OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:QuotaIds
    新增入参:Labels
    新增入参:VerboseFields
出参OpenAPI 返回结构发生变更
2023-06-07OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-11OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceTypes
出参OpenAPI 返回结构发生变更
2023-03-30OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-08-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-08-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-07-26OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Verbose
2021-03-02OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:WorkspaceIds
    新增入参:Option
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈