调用GetInstance接口,获取实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetInstance |
系统规定参数。取值:GetInstance。 |
InstanceId | Long | 是 | 1234 |
实例的ID。您可以调用ListInstances获取。 |
RegionId | String | 是 | cn-shanghai |
地域信息,通常是服务所在的地域。例如,华东2(上海)是cn-shanghai,华北3(张家口)是cn-zhangjiakou。您无需填写RegionId,会根据调用的endpoint自动解析。 |
ProjectEnv | String | 是 | PROD |
工作空间的环境,包括PROD(生产环境)和DEV(开发环境)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
RequestId | String | E6F0DBDD-5AD**** |
请求的ID。用于定位日志,排查问题。 |
ErrorMessage | String | test |
调度实例失败时的异常信息。 |
Success | Boolean | true |
调用是否成功。 |
ErrorCode | String | 0 |
错误码。 |
Data | Object |
实例的详细信息。 |
|
Status | String | NOT_RUN |
任务的状态,取值如下:
|
CycTime | Long | 1590422400000 |
实例的定时时间。 |
BeginRunningTime | Long | 1590416703313 |
实例开始运行的时间。 |
FinishTime | Long | 1590416703313 |
实例运行的结束时间。 |
CreateTime | Long | 1590416703313 |
实例的创建时间。 |
DagId | Long | 338450167 |
工作流的ID。 |
Priority | Integer | 1 |
实例运行优先级,取值分为1、3、5、7和8。取值越大,优先级越高。默认优先级为1。 |
TaskType | String | NORMAL(0) |
实例的调度类型,取值如下:
|
ParamValues | String | bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif |
参数信息。 |
Connection | String | odps_first |
连接串。 |
BaselineId | Long | 123123 |
基线ID。 |
DqcType | Integer | 1 |
数据质量DQC类型,取值如下:
|
DagType | String | DAILY |
工作流的类型,取值如下:
|
BusinessId | Long | 123 |
业务流程ID。 |
TaskRerunTime | Integer | 0 |
实例还可以重跑的次数。取值可以为空、以及大于等于0的整数。
|
ModifyTime | Long | 1590416703313 |
实例的最新修改时间。 |
Repeatability | Boolean | true |
实例是否可以重复执行。 |
RepeatInterval | Long | 60000 |
调度任务运行出错后,重新调整调度频率,单位为毫秒(ms)。 |
InstanceId | Long | 11713307578 |
实例的ID。 |
BeginWaitResTime | Long | 1590416703313 |
实例开始等待资源的时间。 |
RelatedFlowId | Long | 123123 |
关联的业务流程ID。 |
Bizdate | Long | 1590336000000 |
业务日期。通常为该任务运行时间的前一天。 |
NodeName | String | kzh |
节点的名称。 |
BeginWaitTimeTime | Long | 1590416703313 |
实例开始等待调度的时间。 |
DqcDescription | String | [{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}] |
DQC分区规则串。 |
NodeId | Long | 33115 |
节点的ID。 |
CreateUser | String | 111 |
实例创建人。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetInstance
&InstanceId=1234
&ProjectEnv=PROD
&RegionId=cn-shanghai
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RequestId>E6F0DBDD-5AD****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
<BaselineId>123123</BaselineId>
<ModifyTime>1590416703313</ModifyTime>
<NodeName>kzh</NodeName>
<DagType>DAILY</DagType>
<ParamValues>bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif</ParamValues>
<DagId>338450167</DagId>
<BeginRunningTime>1590416703313</BeginRunningTime>
<Bizdate>1590336000000</Bizdate>
<FinishTime>1590416703313</FinishTime>
<DqcDescription>[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]</DqcDescription>
<Status>NOT_RUN</Status>
<TaskType>NORMAL(0)</TaskType>
<TaskRetunTime>0</TaskRetunTime>
<InstanceId>11713307578</InstanceId>
<DqcType>1</DqcType>
<Priority>1</Priority>
<CreateTime>1590416703313</CreateTime>
<Connection>odps_first</Connection>
<RelatedFlowId>123123</RelatedFlowId>
<BeginWaitTimeTime>1590416703313</BeginWaitTimeTime>
<CycTime>1590422400000</CycTime>
<Repeatability>true</Repeatability>
<NodeId>33115</NodeId>
<BeginWaitResTime>1590416703313</BeginWaitResTime>
<ErrorMessage>error message</ErrorMessage>
<RepeatInterval>60000</RepeatInterval>
</Data>
<ErrorCode>0</ErrorCode>
<ErrorMessage>test</ErrorMessage>
<Success>true</Success>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "E6F0DBDD-5AD****",
"HttpStatusCode" : 200,
"Data" : {
"BaselineId" : 123123,
"ModifyTime" : 1590416703313,
"NodeName" : "kzh",
"DagType" : "DAILY",
"ParamValues" : "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
"DagId" : 338450167,
"BeginRunningTime" : 1590416703313,
"Bizdate" : 1590336000000,
"FinishTime" : 1590416703313,
"DqcDescription" : "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
"Status" : "NOT_RUN",
"TaskType" : "NORMAL(0)",
"TaskRetunTime" : 0,
"InstanceId" : 11713307578,
"DqcType" : 1,
"Priority" : 1,
"CreateTime" : 1590416703313,
"Connection" : "odps_first",
"RelatedFlowId" : 123123,
"BeginWaitTimeTime" : 1590416703313,
"CycTime" : 1590422400000,
"Repeatability" : true,
"NodeId" : 33115,
"BeginWaitResTime" : 1590416703313,
"ErrorMessage" : "error message",
"RepeatInterval" : 60000
},
"ErrorCode" : 0,
"ErrorMessage" : "test",
"Success" : true
}
错误码
访问错误中心查看更多错误码。