ListCalcEngines-DataWorks(DataWorks)-阿里云帮助中心

Queries a list of compute engines that are associated with a DataWorks workspace.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace with which the compute engine is associated.	27
Name	string	No	The name of the compute engine, which must be exactly matched.	abc
CalcEngineType	string	Yes	The type of the compute engine. The value of this parameter is not case-sensitive. Valid values: ODPS EMR BLINK HOLO MaxGraph HYBRIDDB_FOR_POSTGRESQL ADB_MYSQL HADOOP_CDH CLICKHOUSE	ODPS
EnvType	string	No	The environment in which the compute engine is used. Valid values: DEV PRD	PRD
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	0bc1ec92159376****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object	The query results for compute engines that are returned on multiple pages.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of compute engine instances.	1
CalcEngines	array<object>	The compute engines.
	array<object>	The returned data.
BindingProjectName	string	The name of the workspace with which the compute engine is associated.	abc
IsDefault	boolean	Indicates whether the compute engine is the default engine of the current type.	true
EngineId	integer	The compute engine ID.	35
DwRegion	string	The region where the DataWorks workspace with which the compute engine is associated resides.	cn-zhangjiakou
TaskAuthType	string	The identity that is used to access the compute engine. Valid values: USER: the current user PROJECT: the workspace executor SUBACCOUNT: a RAM user STS_ROLE: the Security Token Service (STS) role	PROJECT
CalcEngineType	string	The type of the compute engine.	ODPS
EngineInfo	object	The details of the compute engine. ODPS `{ "pubEndpoint": "service.cn.maxcompute.aliyun.com/api", "endpoint": "service.cn.maxcompute.aliyun-inc.com/api", "initProperties": " {\"odpsTypeMode\":\"STANDARD\",\"openPai\":false,\"openPaiGpu\":false}", "resourceGroupType": "ODPS", "resourceGroupId": "361826516****", "vpcEndpoint": "service.cn.maxcompute.aliyun-inc.com/api", "projectName": "onefall_test_zjk", "taskSameAsOwner": "true" }` EMR `{ "emrClusterId": "C-xxx", "specs": "{\"emrClusterId\":\"C-xxx\",\"emrAccessMode\":\"simple\",\"emrResourceQueueName\":\"default\",\"emrProjectId\":\"FP-xxx\"}", "endpoint": "emr.aliyuncs.com", "emrResourceQueueName": "default", "emrAccessMode": "simple", "resourceGroupType": "DW", "projectName": "xx-xxxx", "emrProjectId": "FP-xxxx", "taskSameAsOwner": "false" }` BLINK `{ "bayesProjectId": "xxxx", "bayesProjectName": "xc_blxxixxxnk_1", "cluster": "xxxssxsx", "endpoint": "https://stream.console.aliyun.com", "engineType": "BLINK", "name": "xsxsxxxxx", "projectName": "xc_blxxxsxink_1", "queue": "root.xc_blxsxxxxxxink_1", "resourceGroupType": "DW", "specs": "{\"cluster\":\"xxxxxx\",\"bayesProjectName\":\"xc_blxxixxxnk_1\",\"bayesProjectId\":\"ssxxxsa\",\"name\":\"sxsxsxxx\",\"queue\":\"root.sxxsxxsx\"}", "taskSameAsOwner": false }` HOLO { "endpoint": "hgprecn-cn-xsxssxsx-cn-shanghai-internal.hologres.aliyuncs.com:80", "engineType": "ODPS", "odpsEndpoint": "hgprecn-cn-xsxssxxs-cn-shanghai-internal.hologres.aliyuncs.com:80", "odpsProjectName": "xsxssxsxsx", "projectName": "xsxssxsxsx", "resourceGroupType": "DW", "specs": "{\"pubEndpoint\":\"hgprecn-cn-xsxssxsxs-cn-shanghai.hologres.aliyuncs.com:80\",\"commonBuyInstanceId\":\"hgprecn-cn-xsxsxsxs\",\"project\":\"holo_upxsxgrade1\",\"common_buy_instance_id\":\"hgprecn-cn-xsxsxs\",\"endpoint\":\"hgprecn-cn-xsxxsxs-cn-shanghai-internal.hologres.aliyuncs.com:80\",\"port\":\"80\",\"host\":\"hgprecn-cn-xsxsxsxs-cn-shanghai-internal.hologres.aliyuncs.com\",\"vpcEndpoint\":\"hgprecn-cn-xsxsxsxs-cn-shanghai-vpc.hologres.aliyuncs.com:80\",\"authType\":2,\"region\":\"cn-shanghai\"}", "taskSameAsOwner": false } MaxGraph `{ "endpoint": "http://pre-graphcompute.aliyuncs.com", "engineType": "ODPS", "odpsEndpoint": "http://pre-graphcompute.aliyuncs.com", "odpsProjectName": "xsxsxsxs", "projectName": "xsxsxsxs", "resourceGroupType": "DW", "taskSameAsOwner": false }` HYBRIDDB_FOR_POSTGRESQL `{ "endpoint": "hybriddb_for_postgresql_mo12121ck_endpoint", "engineType": "ODPS", "odpsEndpoint": "hybriddb_for_postgresql_m121212ock_endpoint", "odpsProjectName": "sxasaxsaxaxas", "projectName": "sxasaxsaxaxas", "resourceGroupType": "DW", "specs": "{\"connectionString\":\"gp-xsxsxsxxs.gpdb.rds.aliyuncs.com\",\"database\":\"xsxsxxsxs\",\"password\":\"xxxxxxx\",\"instanceId\":\"gp-cdcdacdacda\",\"port\":\"3432\",\"ownerId\":\"12121212\",\"username\":\"sdasaddsa\"}", "taskSameAsOwner": false }` ADB_MYSQL `{ "endpoint": "adb_mysql_mock_endpoint", "engineType": "ODPS", "odpsEndpoint": "adb_mysql_mock_endpoint", "odpsProjectName": "am-xsaxaxa", "projectName": "am-xsxsaxa", "resourceGroupType": "DW", "specs": "{\"connectionString\":\"am-xsaxsa.ads.aliyuncs.com:3306\",\"database\":\"xsaxsaxa\",\"password\":\"xsaxsaxassxsa\",\"instanceId\":\"am-xsaxsasx\",\"username\":\"xsaxsadsd\"}", "taskSameAsOwner": false }` HADOOP_CDH { "bindingBaseId": "xsaxsaxs", "endpoint": "xsaaaaa", "engineType": "ODPS", "odpsEndpoint": "axsxaxssxs", "odpsProjectName": "ssxxax", "projectName": "xsaxsaxsa", "resourceGroupId": 45208xxxxxx, "resourceGroupType": "GATEWAY", "specs": "{\"cluster\":{\"hive\":{\"hiveServer2Url\":\"jdbc:hive2://xxxxxxer-1-cn-shanghai-pre-kerberos-1:10000\",\"hiveMetastore\":\"thrift://xxxxxxxr-1-cn-shanghai-pre-kerberos-1:9083\",\"version\":\"2.1.1\"},\"configFiles\":{\"coreSite\":\"4534574xxxxxx\",\"hdfsSite\":\"453457919xxxxxxx\",\"mapredSite\":\"45345750xxxxxx\",\"yarnSite\":\"4534575xxxxx\",\"krb5Conf\":\"4534576xxxxx1\",\"hiveSite\":\"453457xxxxx20\"},\"spark\":{\"version\":\"2.4.0\"},\"cdh\":{\"version\":\"6.3.2\"},\"hdfs\":{\"version\":\"3.0.0\"},\"impala\":{\"impalaUrl\":\"jdbc:impala://cdh-xsxssxxsx-1-cn-shanghai-pre-kerberos-1:21050\",\"version\":\"3.2.0\"},\"yarn\":{\"YarnUrl\":\"http://cdh-xsxsxsxsxs-1-cn-shanghai-pre-kerberos-1:8032\",\"webUrl\":\"http://cdh-xsxsxssxxssx-1-cn-shanghai-pre-kerberos-1:8088\",\"version\":\"3.0.0\"},\"presto\":{\"prestoUrl\":\"jdbc:presto://cdh-xssxsxxsxsxs-1-cn-shanghai-pre-kerberos-1:8080/hive/default\",\"version\":\"0.244.1\"}},\"instanceId\":161sdads733,\"authDetail\":{\"principal\":\"hive@HADOOP.COM\",\"keytabFileId\":\"45345815xsxsxs3\",\"type\":\"kerberos\",\"username\":\"xsxsxsxsa@HADOOP.COM\"},\"resGroupStatus\":\"\",\"hadoopAuthType\":\"kerberos\",\"clusterIdentifier\":\"xssxsxsxsx\",\"clusterId\":xsxsx,\"resGroupId\":4520870619xsxssxxs,\"accessMode\":\"security\",\"authType\":2}", "taskSameAsOwner": false }	{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","resourceGroupType":"ODPS","resourceGroupId":"361826516****","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","projectName":"onefall_test_zjk","taskSameAsOwner":"true"}
EnvType	string	The environment in which the compute engine is used. Valid values: DEV PRD	PRD
Region	string	The region where the compute engine resides.	cn-zhangjiakou
GmtCreate	string	The time when the compute engine was created.	Oct 10, 2019 3:42:44 PM
BindingProjectId	integer	The ID of the workspace with which the compute engine is associated.	27
Name	string	The display name of the compute engine.	abc
TenantId	integer	The tenant ID.	1234567

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1,
    "CalcEngines": [
      {
        "BindingProjectName": "test_project",
        "IsDefault": true,
        "EngineId": 35,
        "DwRegion": "cn-zhangjiakou",
        "TaskAuthType": "PROJECT",
        "CalcEngineType": "ODPS",
        "EngineInfo": {
          "pubEndpoint": "service.cn.maxcompute.aliyun.com/api",
          "endpoint": "service.cn.maxcompute.aliyun-inc.com/api",
          "initProperties": " {\"odpsTypeMode\":\"STANDARD\",\"openPai\":false,\"openPaiGpu\":false}",
          "resourceGroupType": "ODPS",
          "resourceGroupId": "361826516****",
          "vpcEndpoint": "service.cn.maxcompute.aliyun-inc.com/api",
          "projectName": "onefall_test_zjk",
          "taskSameAsOwner": "true"
        },
        "EnvType": "PRD",
        "Region": "cn-zhangjiakou",
        "GmtCreate": "Oct 10, 2019 3:42:44 PM",
        "BindingProjectId": 466230,
        "Name": "test_mc",
        "TenantId": 1234567
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	The project does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	The user is not in the project.
400	Invalid.CalcEngineEnvType	The specified envType %s is invalid.	The specify env type %s invalid
400	Invalid.CalcEngineType	The specified calcEngineType %s is invalid.	The specify calc engine type %s invalid.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	The user is not in tenant.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.