Get Tasks Details in Batch
Action
ListGenerateTaskDetail
Introduction
⚠️
This interface is no longer maintained.
This interface is used for quering tasks details and results in batch.
Request
Parameter Name | Type | Description | Required |
---|---|---|---|
Action | String | The corresponding API command name, the current API is ListGenerateTaskDetail | ✓ |
PublicKey | String | User's public key, can be obtained from User Center (opens in a new tab) | ✓ |
Signature | String | User signature generated based on public key and API command, see Signature | ✓ |
request_uuid | String | Request UUID, randomly generated using UUID generation method | |
TaskUIDs | []String | Task UID list | ✓ |
Request Example
{
"Action": "ListGenerateTaskDetail",
"PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
"Signature": "83a99d5f74dab5a46b1b9d4c3ec0d3ec5595c958",
"TaskUIDs": [
"taskuid1",
"taskuid2"
]
}
Response
Parameter Name | Type | Description | Required |
---|---|---|---|
RetCode | Int | Return status code, 0 for successful return, non-zero for failure | ✓ |
Action | String | Operation command name | ✓ |
Message | String | Return error message, provide detailed description when RetCode is non-zero | |
TaskDetailList | []TaskDetail | Task list details | ✓ |
TaskDetail
Parameter Name | Type | Description | Required |
---|---|---|---|
TaskUid | String | Task UID | ✓ |
TaskType | String | Task type | ✓ |
TaskStatus | String | Current task status, possible values: Queuing, Running, Finished, Error | ✓ |
FinalPictureUrls | []String | Result picture URLs | |
TaskErrorMsg | String | Error message when an error occurs | |
TaskErrorCode | Int | Error code when an error occurs, 0 indicates normal operation |
Response Example
{
"Action": "ListGenerateTaskDetail",
"RetCode": 0,
"Message": "",
"TaskDetailList": [
{
"TaskUid": "taskuid1",
"TaskType": "TaskGeneratePicture",
"TaskStatus": "Finished",
"FinalPictureUrls": [
"xxxxxx"
],
"TaskErrorMsg": "",
"TaskErrorCode": 0
},
{
"TaskUid": "taskuid2",
"TaskType": "TaskGeneratePicture",
"TaskStatus": "Finished",
"FinalPictureUrls": [
"xxxxxx"
],
"TaskErrorMsg": "",
"TaskErrorCode": 0
}
]
}