Queries a list of compute engines that are associated with a DataWorks workspace.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:* | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectId | long | 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 |
| EnvType | string | No | The environment in which the compute engine is used. Valid values:
| 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 parameters
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 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|