Queries compute engines.

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.
CalcEngineType String Yes ODPS

The type of the computing engine. For example, maxcompute and e-MapReduce.
Name String Yes abc

The name of the compute engine.
ProjectId Long Yes 27

The Dataworks workspace to which the Compute Engine belongs.
RegionId String Yes cn-shanghai

The region ID of the compute engine.
EnvType String No PROD

The environment to which the computing engine belongs, including the development environment (DEV) and the production environment (PROD).

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.
PageNumber Integer No 1

The page number to be queried.

Response parameters

Parameter Type Example Description
Data Struct

Compute engines to display the query results by page.
CalcEngines Array of CalcEngines

The list of compute engines.
BindingProjectId Integer 27

The ID of the workspace bound to the compute engine.
BindingProjectName String abc

The name of the workspace associated with the compute engine.
CalcEngineType String ODPS

The type of the compute engine.
DwRegion String cn-zhangjiakou

The region of the Dataworks workspace associated with the compute engine.
EngineId Integer 35

The ID of the compute engine.
EngineInfo Map {"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"}

A list of compute engines.
EnvType String PROD

The environment where the compute engine is located.
GmtCreate String Oct 10, 2019 3:42:44 PM

The time when the compute engine was created.
IsDefault Boolean true

Indicates whether the Compute Engine is the default compute engine of the current data type.

Name String abc

The display name of the compute engine.
Region String cn-zhangjiakou

The region where the compute engine is located.
TaskAuthType String PROJECT

The access identity of the compute engine.
TenantId Long 1234567

The ID of the tenant.
PageNumber Integer 1

The page that is returned.
PageSize Integer 20

The number of entries to return on each page. Default value: 10. Maximum value: 100.
TotalCount Integer 1

The total number of compute engines.
HttpStatusCode Integer 200

The HTTP status code.
RequestId String 0bc1ec92159376****

The ID of the request.
Success Boolean true

Indicates whether the Compute Engine list is displayed.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=ListCalcEngines&calcingetype=ODPS &Name=abc &ProjectId=27 &RegionId=cn-shanghai &<common request parameters>

Sample success responses

XML format 


     <data> <calcEngines> <bindingProjectId>27</bindingProjectId> <bindingProjectName>abc</bindingProjectName> <calcEngineType>ODPS</calcEngineType> <dwRegion>cn-zhangjiakou</dwRegion> <engineId>35</engineId> <engineInfo> <pubEndpoint>http://service.cn.maxcompute.aliyun.com/api</pubEndpoint> <endpoint>http://service.cn.maxcompute.aliyun-inc.com/api</endpoint> <resourceGroupType>ODPS</resourceGroupType> <resourceGroupId>361826516****</resourceGroupId> <vpcEndpoint>http://service.cn.maxcompute.aliyun-inc.com/api</vpcEndpoint> <projectName>abc</projectName> <taskSameAsOwner>true</taskSameAsOwner> </engineInfo> <envType>PROD</envType> <gmtCreate>Oct 10, 2019 3:42:44 PM <isDefault>true</isDefault> <name>abc</name> <region>cn-zhangjiakou</region> <taskAuthType>PROJECT</taskAuthType> <tenantId>1234567</tenantId> </calcEngines> <pageNumber>1</pageNumber> <pageSize>20</pageSize> <totalCount>1</totalCount> </data> <httpStatusCode>200</httpStatusCode> <requestId>0bc1ec92159376****</requestId> <success>true</success>

JSON Hint 


     { "data": { "calcEngines": [ { "bindingProjectId": 27, "bindingProjectName": "abc", "calcEngineType": "ODPS", "dwRegion": "cn-zhangjiakou", "engineId": 35, "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": "abc", "taskSameAsOwner": "true" }, "envType": "PROD", "gmtCreate": "Oct 10, 2019 3:42:44 PM", "isDefault": true, "name": "abc", "region": "cn-zhangjiakou", "taskAuthType": "PROJECT", "tenantId": 1234567 } ], "pageNumber": 1, "pageSize": 20, "totalCount": 1 }, "httpStatusCode": 200, "requestId": "0bc1ec92159376****", "success": true }

Error codes

HttpCode Error code Error message Description
400 Invalid.Tenant.ConnectionNotExists The connection does not exist. The data source does not exist.
400 Invalid.Tenant.ProjectNotExists The project does not exist. The error message returned because the specified project does not exist.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. The user is not the project owner or project administrator.
400 Invalid.Tenant.UserNotInProject The user is not in the project. The user is not in the project.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. The user is not in the tenant.

Go to the Error CenterFor more information, see error codes.