调用GetInstance接口,获取实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:* |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
integer |
是 |
实例的 ID。您可以调用 ListInstances 获取。 |
1234 |
| ProjectEnv |
string |
是 |
工作空间的环境,包括 PROD(生产环境)和 DEV(开发环境)。 枚举值:
|
PROD |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回实体。 |
||
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| RequestId |
string |
请求的 ID。用于定位日志,排查问题。 |
E6F0DBDD-5AD**** |
| ErrorMessage |
string |
调度实例失败时的异常信息。 |
test |
| Success |
boolean |
调用是否成功。 |
true |
| ErrorCode |
string |
错误码。 |
0 |
| Data |
object |
实例的详细信息。 |
|
| Status |
string |
任务的状态,取值如下:
|
NOT_RUN |
| CycTime |
integer |
实例的定时时间。 格式示例为 13 位数字,例如 |
1590422400000 |
| BeginRunningTime |
integer |
实例开始运行的时间。 格式示例为 13 位数字,例如 |
1590416703313 |
| FinishTime |
integer |
实例运行的结束时间。 格式示例为 13 位数字,例如 |
1590416703313 |
| CreateTime |
integer |
实例的创建时间。 格式示例为 13 位数字,例如 |
1590416703313 |
| DagId |
integer |
工作流的 ID。 |
338450167 |
| Priority |
integer |
实例运行优先级,取值分为 1、3、5、7 和 8。取值越大,优先级越高。默认优先级为 1。 |
1 |
| TaskType |
string |
实例的调度类型,取值如下:
|
NORMAL(0) |
| ParamValues |
string |
参数信息。 |
bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif |
| Connection |
string |
连接串。 |
odps_source |
| BaselineId |
integer |
基线 ID。 |
123123 |
| DqcType |
integer |
数据质量 DQC 类型,取值如下:
|
1 |
| DagType |
string |
工作流的类型,取值如下:
|
DAILY |
| BusinessId |
integer |
业务流程 ID。 |
123 |
| TaskRerunTime |
integer |
实例还可以运行的次数。取值可以为空、以及大于等于 0 的整数。
|
0 |
| PeriodNumber |
integer |
周期序号。表示任务实例处于当天的第几轮周期。 |
1 |
| ModifyTime |
integer |
实例的最新修改时间。 格式示例为 13 位数字,例如 |
1590416703313 |
| Repeatability |
boolean |
实例是否可以重复执行。 |
true |
| RepeatInterval |
integer |
调度任务运行出错后,重新调整调度频率,单位为毫秒(ms)。 |
60000 |
| InstanceId |
integer |
实例的 ID。 |
11713307578 |
| BeginWaitResTime |
integer |
实例开始等待资源的时间。 格式示例为 13 位数字,例如 |
1590416703313 |
| RelatedFlowId |
integer |
关联的业务流程 ID。 |
123123 |
| Bizdate |
integer |
业务日期。通常为该任务运行时间的前一天。 格式示例为 13 位数字,例如 |
1590336000000 |
| NodeName |
string |
节点的名称。 |
kzh |
| BeginWaitTimeTime |
integer |
实例开始等待调度的时间。 格式示例为 13 位数字,例如 |
1590416703313 |
| DqcDescription |
string |
DQC 分区规则串。 |
[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}] |
| NodeId |
integer |
节点的 ID。 |
33115 |
| CreateUser |
string |
实例创建人。 |
111 |
| Owner |
string |
实例责任人。 |
111 |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"RequestId": "E6F0DBDD-5AD****",
"ErrorMessage": "test",
"Success": true,
"ErrorCode": "0",
"Data": {
"Status": "NOT_RUN",
"CycTime": 1590422400000,
"BeginRunningTime": 1590416703313,
"FinishTime": 1590416703313,
"CreateTime": 1590416703313,
"DagId": 338450167,
"Priority": 1,
"TaskType": "NORMAL(0)",
"ParamValues": "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
"Connection": "odps_source",
"BaselineId": 123123,
"DqcType": 1,
"DagType": "DAILY",
"BusinessId": 123,
"TaskRerunTime": 0,
"PeriodNumber": 1,
"ModifyTime": 1590416703313,
"Repeatability": true,
"RepeatInterval": 60000,
"InstanceId": 11713307578,
"BeginWaitResTime": 1590416703313,
"RelatedFlowId": 123123,
"Bizdate": 1590336000000,
"NodeName": "kzh",
"BeginWaitTimeTime": 1590416703313,
"DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
"NodeId": 33115,
"CreateUser": "111",
"Owner": "111"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。