Updated on 2024-04-29 GMT+08:00

Canceling Task Packages

Function

This API is used to cancel task packages.

URI

  • URI format

    POST /v2/{project_id}/factory/release-packages/unpack

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain a project ID, see Project ID and Account ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.

X-Auth-Token

No

String

IAM token

Minimum length: 0

Maximum length: 4096

Content-Type

No

String

This parameter is mandatory if the body is available. If the body is unavailable, you do not need to set and verify this parameter.

Example: Content-Type: application/json;charset=UTF-8

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

package_ids

No

array[string]

IDs of release packages

Response Parameters

None

Example Request

POST /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/release-packages/unpack
{"package_ids":["12","13"]}

Example Response

  • Success response

    HTTP status code 200

  • Failure response

    HTTP status code 400

    {
      "error_code": "DLF.0810",
      "error_msg": "Task does not exist."
    }