Get Task Detail

Action GetGenerateTaskDetail

Introduction

⚠️

This interface is no longer maintained.

This interface is used to get the details and results of a task.

Request

Parameter Name	Type	Description	Required
Action	`String`	The corresponding API command name, which is `GetGenerateTaskDetail` for this API	✓
PublicKey	`String`	User's public key, which can be obtained from User Center (opens in a new tab)	✓
Signature	`String`	User's signature generated based on the public key and API command, see Signature	✓
request_uuid	`String`	Request UUID, randomly generated using UUID generation method
TaskUID	`String`	Task UID	✓

Request Example

{
    "Action":    "GetGenerateTaskDetail",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "Signature": "fbe9cb6bad175e885e85b13f6a202bec59f48d90",
    "request_uuid":"random_uuid",
    "TaskUID": "cjr997tleg738lelk3n0"
    
}

Response

Field Name	Type	Description	Required
RetCode	`Int`	Return status code. 0 indicates successful return, non-zero indicates failure	✓
Action	`String`	Operation command name	✓
Message	`String`	Error message returned when `RetCode` is non-zero
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": "",
    "RetCode": 0,
    "Message": "",
    "TaskType": "TaskGeneratePicture",
    "TaskStatus": "Finished",
    "FinalPictureUrls": [
        "xxxxx.png"
    ],
    "TaskErrorMsg": "",
    "TaskErrorCode": 0
}

List Running Tasks Get Tasks Details in Batch