调用ListCalcEngines查看计算引擎列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListCalcEngines | 要执行的操作。 |
| CalcEngineType | String | 是 | ODPS | 计算引擎类型。目前支持 |
| Name | String | 是 | abc | 查询的计算引擎名称，精确匹配。 |
| ProjectId | Long | 是 | 27 | 计算引擎所属的Dataworks工作空间。 |
| RegionId | String | 是 | cn-shanghai | 计算引擎所属的地域信息。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。 |
| EnvType | String | 否 | PRD | 计算引擎所属的环境，包括开发环境（DEV）和生产环境（PRD）。 |
| PageSize | Integer | 否 | 10 | 每页显示的条数，默认为10条，最大20条。 |
| PageNumber | Integer | 否 | 1 | 分页查询页码。大于等于1的正整数，默认为1。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Data | Struct | 计算引擎的分页查询结果。 |
|
| CalcEngines | Array of CalcEngines | 计算引擎列表。 |
|
| BindingProjectId | Integer | 27 | 计算引擎绑定的工作空间ID。 |
| BindingProjectName | String | abc | 计算引擎关联的工作空间名称。 |
| CalcEngineType | String | ODPS | 计算引擎类型。值枚举列表 |
| DwRegion | String | cn-zhangjiakou | 计算引擎关联的Dataworks工作空间所在的地域。 |
| EngineId | Integer | 35 | 计算引擎ID。 |
| 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"} | 计算引擎的详细信息。
|
| EnvType | String | PRD | 计算引擎所在的环境。
|
| GmtCreate | String | Oct 10, 2019 3:42:44 PM | 计算引擎的创建时间。时间戳 |
| IsDefault | Boolean | true | 是否为当前类型的默认计算引擎。 |
| Name | String | abc | 计算引擎的显示名称。 |
| Region | String | cn-zhangjiakou | 计算引擎所在的地域。 |
| TaskAuthType | String | PROJECT | 计算引擎的访问身份。
|
| TenantId | Long | 1234567 | 租户ID。 |
| PageNumber | Integer | 1 | 页码。 |
| PageSize | Integer | 20 | 每页显示的条数，默认为10条，最大100条。 |
| TotalCount | Integer | 1 | 计算引擎的总数。 |
| HttpStatusCode | Integer | 200 | HTTP状态码。 |
| RequestId | String | 0bc1ec92159376**** | 请求ID。 |
| Success | Boolean | true | 是否成功查看计算引擎列表。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListCalcEngines
&CalcEngineType=ODPS
&Name=abc
&ProjectId=27
&RegionId=cn-shanghai
&<公共请求参数>正常返回示例
XML格式
<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</gmtCreate>
<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格式
{
"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
}错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Invalid.Tenant.ConnectionNotExists | The connection does not exist. | 数据源不存在。 |
| 400 | Invalid.Tenant.ProjectNotExists | The project does not exist. | 项目不存在。 |
| 403 | Invalid.Tenant.UserIsNotProjectOwnerOrAdmin | The user is not a project administrator or owner. | 用户不是项目负责人或者项目管理员。 |
| 400 | Invalid.Tenant.UserNotInProject | The user is not in the project. | 用户不在项目中。 |
| 403 | Invalid.Tenant.UserNotInTenant | The user is not in tenant. | 用户不在租户中。 |
访问错误中心查看更多错误码。