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