API Reference (Legacy)
Get Tasks Details in Batch

Get Tasks Details in Batch

API ListGenerateTaskDetail

Introduction

⚠️

This interface is no longer maintained.

This interface is used for quering tasks details and results in batch.

Request

Parameter NameTypeDescriptionRequired
ActionstringThe corresponding API command name, the current API is ListGenerateTaskDetail
PublicKeystringUser's public key, can be obtained from User Center (opens in a new tab)
SignaturestringUser signature generated based on public key and API command, see Signature
request_uuidstringRequest UUID, randomly generated using UUID generation method
TaskUIDs[]stringTask UID list

Request Example

{
	"Action": "ListGenerateTaskDetail",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "Signature": "83a99d5f74dab5a46b1b9d4c3ec0d3ec5595c958",
	"TaskUIDs": [
		"taskuid1",
		"taskuid2"
	]
}

Response

Parameter NameTypeDescriptionRequired
RetCodeintReturn status code, 0 for successful return, non-zero for failure
ActionstringOperation command name
MessagestringReturn error message, provide detailed description when RetCode is non-zero
TaskDetailList[]TaskDetailTask list details

TaskDetail

Parameter NameTypeDescriptionRequired
TaskUidstringTask UID
TaskTypestringTask type
TaskStatusstringCurrent task status, possible values: Queuing, Running, Finished, Error
FinalPictureUrls[]stringResult picture URLs
TaskErrorMsgstringError message when an error occurs
TaskErrorCodeintError 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
		}
	]
}