调用ListComputeResources接口获取计算资源列表-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

根据计算资源业务信息，查询符合的计算资源列表。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。
需要在 DataWorks 项目空间中具有如下至少一种角色：
租户所有者、空间管理员、部署、开发、访客、项目所有者、运维、模型设计师、安全管理员、数据分析师、开发平台管理员、数据治理管理员

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListComputeResources

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ProjectId	integer	是	DataWorks 工作空间的 ID。	21229
Name	string	否	计算资源的名称。	category name
Types	array	否	计算资源类型查询过滤，可以配置多个类型查询过滤。
	string	否	计算资源的类型。	hologres
EnvType	string	否	计算资源环境类型，枚举值： Dev：开发环境 Prod：生产环境	Dev
PageNumber	integer	否	查询第几页，默认值为 1 表示第一页。	1
PageSize	integer	否	分页大小，默认值为 10，最大值 100。	10
SortBy	string	否	计算资源列表排序字段，支持名称、创建时间、计算资源 ID 排序 CreateTime：创建时间 Id：计算资源 ID Name：计算资源名称 CreateTimeWithDefaultFirst：基于默认与否和创建时间排序，默认计算资源排序在前默认值：CreateTime	CreateTimeWithDefaultFirst
Order	string	否	计算资源列表排序方向，枚举值： Desc：倒序 Asc：正序默认值：Desc	Asc

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。用于定位日志，排查问题。	7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
PagingInfo	object	分页信息。
TotalCount	integer	总条数。	100
PageSize	integer	页大小。	10
PageNumber	integer	页码。	1
ComputeResources	array<object>	计算资源列表，每一个元素是一个计算资源组，包含开发环境（如有）和生产环境的信息。
	array<object>	计算资源组信息，包含开发环境（如有）和生产环境的计算资源。开发环境和生产环境的计算资源具有相同的计算资源名称和计算资源类型，不相同的计算资源 ID。
Name	string	计算资源的名称。	cal_all_vemg_workflow_parallel
Type	string	计算资源类型。	hologres
ComputeResource	array<object>	单条计算资源信息。
	object	单条计算资源信息。
Id	integer	计算资源 ID，计算资源的唯一标识符。	8649832502405358603
ConnectionProperties	any	计算资源添加的类别，不同 type 下会有不同的子类型，对应有不同的参数约束，场景举例： InstanceMode 实例模式。 UrlMode 连接串模式。	{\n \"clusterIdentifier\": \"c-da123456\",\n \"database\": \"testdb\",\n \"loginMode\":\"Anonymous\",\n \"defaultFS\":\"127.0.0.1\",\n \"envType\": \"Prod\"\n}
ConnectionPropertiesMode	string	计算资源的具体连接配置信息，包括连接地址、访问身份、环境信息等。计算资源环境 envType 信息是此对象的成员属性，包括 Dev（开发环境） Prod（生产环境）不同类型的计算资源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范	UrlMode
Description	string	计算资源 ID，计算资源的唯一标识符。	home_feed
CreateTime	integer	创建时间（时间戳）	1624387842781448
CreateUser	string	创建者 ID。	1648711113000
ModifyTime	integer	计算资源的最近修改时间（时间戳）。	1624387842781448
ModifyUser	string	计算资源的修改者 ID。	1648711113000
WhetherDefault	boolean	是否为默认计算资源	true

示例

正常返回示例

JSON格式

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "PagingInfo": {
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1,
    "ComputeResources": [
      {
        "Name": "cal_all_vemg_workflow_parallel",
        "Type": "hologres",
        "ComputeResource": [
          {
            "Id": 8649832502405359000,
            "ConnectionProperties": "{\\n    \\\"clusterIdentifier\\\": \\\"c-da123456\\\",\\n    \\\"database\\\": \\\"testdb\\\",\\n    \\\"loginMode\\\":\\\"Anonymous\\\",\\n    \\\"defaultFS\\\":\\\"127.0.0.1\\\",\\n    \\\"envType\\\": \\\"Prod\\\"\\n}",
            "ConnectionPropertiesMode": "UrlMode",
            "Description": "home_feed",
            "CreateTime": 1624387842781448,
            "CreateUser": "1648711113000",
            "ModifyTime": 1624387842781448,
            "ModifyUser": "1648711113000",
            "WhetherDefault": true
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。