API Reference
Terminate Task

Terminate a Running Task

Action TerminateTask

Introduction

This interface is used to terminate the task being executed.

Request

Parameter NameTypeDescriptionRequired
ActionStringThe corresponding API instruction name
PublicKeyStringUser's public key, which can be obtained from the PICPIK User Center (opens in a new tab)
SignatureStringUser's signature generated based on the public key and API instruction, see Signature for details
request_uuidStringRequest UUID, randomly generated by using the UUID generation method. This parameter can be utilized to manage the requests of your business and clients.
Field NameTypeDescriptionRequired
TaskUIDStringTask UID

Request Example

{
    "Action":    "TerminateTask",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "request_uuid":"b91fcfbe-bb35-47ce-a168-bd6252c75270",
    "Signature": "0131f4e4296f3ca8e1220b47247e83a4315ea8e1",
    "TaskUID": "costl4if2fkab1j6iv6g"
}

Response

Field NameTypeDescriptionRequired
RetCodeIntReturn status code: 0 indicates a successful return, while non-zero indicates a failure
ActionStringInstruction name
MessageStringThe error message is returned when RetCode is non-zero, providing a detailed description
request_uuidStringReturns the UUID that was included in the request

Response Example

{
	"Action": "TerminateTask",
	"RetCode": 0,
	"Message": "",
	"request_uuid": "2dcc219d-0e84-40d4-a6df-bd30c973fc0b"
}