获取指定的任务实例的详细信息。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dataworks:* | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Id | long | 是 | 任务实例的唯一标识符 | 1234 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77****",
"TaskInstance": {
"TaskId": 1234,
"TaskType": "ODPS_SQL",
"TaskName": "SQL node\n",
"Description": "test",
"WorkflowId": 1234,
"WorkflowName": "Test workflow",
"TriggerType": "Scheduler",
"TriggerRecurrence": "Normal",
"WorkflowInstanceId": 1234,
"WorkflowInstanceType": "Normal",
"Timeout": 3600,
"RerunMode": "AllAllowed",
"RunNumber": 1,
"PeriodNumber": 1,
"BaselineId": 1234,
"Priority": 1,
"Script": {
"Content": "echo \"helloWorld\"",
"Parameters": "para1=$bizdate"
},
"RuntimeResource": {
"ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
"Image": "i-xxxxxx",
"Cu": "0.25"
},
"Runtime": {
"ProcessId": "T3_123",
"Gateway": "cn-shanghai.1.2"
},
"DataSource": {
"Name": "mysql_test"
},
"Inputs": {
"Variables": [
{
"Name": "Key1",
"Type": "Constant",
"Value": "Value1"
}
]
},
"Outputs": {
"TaskOutputs": [
{
"Output": "pre.odps_sql_demo_0"
}
],
"Variables": [
{
"Name": "key1",
"Type": "Constant",
"Value": "value1"
}
]
},
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
],
"Status": "Success",
"TriggerTime": 1710239005403,
"Bizdate": 1710239005403,
"StartedTime": 1710239005403,
"FinishedTime": 1710239005403,
"Id": 1234,
"ProjectId": 100,
"ProjectEnv": "Prod",
"Owner": "1000",
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"CreateUser": "1000",
"ModifyUser": "1000"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-01-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-11-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |