Queries compute engine instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListCalcEngines

The operation that you want to perform. Set the value to ListCalcEngines.

RegionId String Yes cn-shanghai

The region ID of the compute engine instances. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system determines the value of this parameter based on the endpoint that is used to call the operation.

ProjectId Long Yes 27

The DataWorks workspace with which the compute engine instances are associated.

Name String No abc

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

CalcEngineType String Yes ODPS

The type of the compute engine instance. Valid values: ODPS, EMR, BLINK, HOLO, MaxGraph, HYBRIDDB_FOR_POSTGRESQL, ADB_MYSQL, and HADOOP_CDH. The values are not case-sensitive.

EnvType String No PRD

The environment in which the compute engine instance runs. Valid values: DEV and PRD. The value DEV indicates the development environment, and the value PRD indicates the production environment.

PageSize Integer No 10

The number of entries to return on each page. Default value: 100. Maximum value: 100.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0bc1ec92159376****

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Data Object

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

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 20

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

TotalCount Integer 1

The total number of compute engine instances.

CalcEngines Array of CalcEngines

The compute engine instances.

BindingProjectName String abc

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

IsDefault Boolean true

Indicates whether the compute engine instance is the default instance of the same compute engine type.

EngineId Integer 35

The ID of the compute engine instance.

DwRegion String cn-zhangjiakou

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

TaskAuthType String PROJECT

The identity that is used to access the compute engine instance. Valid values:

  • USER: current user
  • PROJECT: Alibaba Cloud account
  • SUBACCOUNT: RAM user
  • STS_ROLE: Security Token Service (STS) role
CalcEngineType String ODPS

The type of the compute engine instance. Valid values: ODPS, EMR, BLINK, HOLO, MaxGraph, HYBRIDDB_FOR_POSTGRESQL, ADB_MYSQL, and HADOOP_CDH.

EngineInfo Map

The details of the compute engine instance.

  • ODPS
    
    {
      "pubEndpoint": "service.cn.maxcompute.aliyun.com/api",
      "endpoint": "service.cn.maxcompute.aliyun-inc.com/api",
      "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
}
                                
EnvType String PRD

The environment in which the compute engine instance runs. Valid values:

  • DEV: development environment
  • PRD: production environment
Region String cn-zhangjiakou

The region ID of the compute engine instance.

GmtCreate String Oct 10, 2019 3:42:44 PM

The time when the compute engine instance was created. This value is a timestamp.

BindingProjectId Integer 27

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

Name String abc

The display name of the compute engine instance.

TenantId Long 1234567

The ID of the tenant.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListCalcEngines
&ProjectId=27
&Name=abc
&CalcEngineType=ODPS
&EnvType=PRD
&PageSize=10
&PageNumber=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListCalcEnginesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0bc1ec92159376****</RequestId>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>20</PageSize>
        <TotalCount>1</TotalCount>
        <CalcEngines>
            <BindingProjectName>abc</BindingProjectName>
            <IsDefault>true</IsDefault>
            <EngineId>35</EngineId>
            <DwRegion>cn-zhangjiakou</DwRegion>
            <TaskAuthType>PROJECT</TaskAuthType>
            <CalcEngineType>ODPS</CalcEngineType>
            <EnvType>PRD</EnvType>
            <Region>cn-zhangjiakou</Region>
            <GmtCreate>Oct 10, 2019 3:42:44 PM</GmtCreate>
            <BindingProjectId>27</BindingProjectId>
            <Name>abc</Name>
            <TenantId>1234567</TenantId>
        </CalcEngines>
    </Data>
</ListCalcEnginesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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",
      "EnvType" : "PRD",
      "Region" : "cn-zhangjiakou",
      "GmtCreate" : "Oct 10, 2019 3:42:44 PM",
      "BindingProjectId" : 27,
      "Name" : "abc",
      "TenantId" : 1234567
    }
  }
}

Error codes

HTTP status code Error code Error message Description
400 Invalid.Tenant.ConnectionNotExists The connection does not exist. The error message returned because the specified data source does not exist.
400 Invalid.Tenant.ProjectNotExists The project does not exist. The error message returned because the specified workspace does not exist.
400 Invalid.Tenant.UserNotInProject The user is not in the project. The error message returned because the user is not added to the workspace.
400 Invalid.CalcEngineEnvType The specified envType %s is invalid. The error message returned because the value of the EnvType parameter is invalid.
400 Invalid.CalcEngineType The specified calcEngineType %s is invalid. The error message returned because the value of the CalcEngineType parameter is invalid.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. The error message returned because the user is not the workspace owner or administrator.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. The error message returned because the user does not belong to the tenant.

For a list of error codes, visit the API Error Center.