All Products
Search
Document Center

DataWorks:ListCalcEngines

Last Updated:Oct 17, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The ID of the DataWorks workspace with which the compute engine is associated.

27
NamestringNo

The name of the compute engine, which must be exactly matched.

abc
CalcEngineTypestringYes

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
EnvTypestringNo

The environment in which the compute engine is used. Valid values:

  • DEV
  • PRD
PRD
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The request ID.

0bc1ec92159376****
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Dataobject

The query results for compute engines that are returned on multiple pages.

PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of compute engine instances.

1
CalcEnginesarray<object>

The compute engines.

CalcEnginesobject

The returned data.

BindingProjectNamestring

The name of the workspace with which the compute engine is associated.

abc
IsDefaultboolean

Indicates whether the compute engine is the default engine of the current type.

true
EngineIdinteger

The compute engine ID.

35
DwRegionstring

The region where the DataWorks workspace with which the compute engine is associated resides.

cn-zhangjiakou
TaskAuthTypestring

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
CalcEngineTypestring

The type of the compute engine.

ODPS
EngineInfoobject

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"}
EnvTypestring

The environment in which the compute engine is used. Valid values:

  • DEV
  • PRD
PRD
Regionstring

The region where the compute engine resides.

cn-zhangjiakou
GmtCreatestring

The time when the compute engine was created.

Oct 10, 2019 3:42:44 PM
BindingProjectIdinteger

The ID of the workspace with which the compute engine is associated.

27
Namestring

The display name of the compute engine.

abc
TenantIdlong

The tenant ID.

1234567

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "0bc1ec92159376****",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1,
    "CalcEngines": [
      {
        "BindingProjectName": "abc",
        "IsDefault": true,
        "EngineId": 35,
        "DwRegion": "cn-zhangjiakou",
        "TaskAuthType": "PROJECT",
        "CalcEngineType": "ODPS",
        "EngineInfo": {
          "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": "PRD",
        "Region": "cn-zhangjiakou",
        "GmtCreate": "Oct 10, 2019 3:42:44 PM",
        "BindingProjectId": 27,
        "Name": "abc",
        "TenantId": 1234567
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.Tenant.ConnectionNotExistsThe connection does not exist.The connection does not exist.
400Invalid.Tenant.ProjectNotExistsThe project does not exist.The project does not exist.
400Invalid.Tenant.UserNotInProjectThe user is not in the project.The user is not in the project.
400Invalid.CalcEngineEnvTypeThe specified envType %s is invalid.The specify env type %s invalid
400Invalid.CalcEngineTypeThe specified calcEngineType %s is invalid.The specify calc engine type %s invalid.
403Invalid.Tenant.UserIsNotProjectOwnerOrAdminThe user is not a project administrator or owner.The user is not a project administrator or owner.
403Invalid.Tenant.UserNotInTenantThe user is not in tenant.The user is not in tenant.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history