调用ListTaskFlow接口,获取任务流信息列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListTaskFlow |
系统规定参数。取值:ListTaskFlow。 |
| Tid | Long | 否 | 3*** |
租户ID,可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。 |
| RegionId | String | 否 | cn-hangzhou |
DMS服务地域,取值请参见RegionID参数说明。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 4116147E-C628-5816-8779-8EEAF8E973F4 |
请求ID。 |
| ErrorCode | String | 403 |
错误码。 |
| ErrorMessage | String | UnknownError |
错误信息。 |
| Success | Boolean | true |
请求是否成功,返回值如下:
|
| TaskFlowList | Array of TaskFlow |
任务流信息列表。 |
|
| TaskFlow | |||
| Id | Long | 134137**** |
任务流ID。 |
| CreatorId | String | 51**** |
创建人的用户ID。 |
| CreatorNickName | String | Creator_NickName |
创建人的昵称。 |
| DagOwnerNickName | String | Owner_NickName |
任务流Owner的昵称。 |
| DeployId | Long | 12** |
最近一次部署记录的ID。 |
| Status | Integer | 2 |
任务流状态,返回值如下:
|
| LatestInstanceStatus | Integer | 0 |
最后一个运行记录的状态,返回值如下:
|
| LatestInstanceTime | String | 2022-04-13 |
最近一个运行记录的创建时间。 |
示例
请求示例
http(s)://dms-enterprise.aliyuncs.com/?Action=ListTaskFlow
&Tid=3***
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListTaskFlowResponse>
<RequestId>4116147E-C628-5816-8779-8EEAF8E973F4</RequestId>
<Success>true</Success>
<TaskFlowList>
<CreatorId>51****</CreatorId>
<CreatorNickName>Creator_NickName</CreatorNickName>
<DagOwnerNickName>Owner_NickName</DagOwnerNickName>
<Status>2</Status>
<LatestInstanceStatus>0</LatestInstanceStatus>
<LatestInstanceTime>2022-04-13</LatestInstanceTime>
</TaskFlowList>
</ListTaskFlowResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "4116147E-C628-5816-8779-8EEAF8E973F4",
"Success" : true,
"TaskFlowList" : [ {
"CreatorId" : "51****",
"CreatorNickName" : "Creator_NickName",
"DagOwnerNickName" : "Owner_NickName",
"Status" : 2,
"LatestInstanceStatus" : 0,
"LatestInstanceTime" : "2022-04-13"
} ]
}
错误码
访问错误中心查看更多错误码。