Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs (V2)/ Job Development APIs/ Releasing Task Packages
Updated on 2024-11-06 GMT+08:00
View PDF
Share

Releasing Task Packages

Function

This API is used to release task packages.

URI

  • URI format

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

  • 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

Yes

array[string]

IDs of the packages to be released. The value cannot be empty or contain more than 100 IDs.

startup_mode

No

Integer

Whether to start a job immediately after the package is released. The value can be 0 or 1. The default value is 1.

1: A job is immediately started after the package is released.

0: A job is not immediately started after the package is released.

Response Parameters

Table 4 Parameters

Parameter

Mandatory

Type

Description

deploy_package_details

No

List<Object>

Information about the package to be released. For details, see Table 5.
Table 5 deploy_package_details data structure

Parameter

Mandatory

Type

Description

asy_subtask_num

No

Integer

Total number of subtasks that are executed asynchronously

asy_task_id

No

String

ID of the asynchronous job, which is returned to the console for polling.

package_id

No

Long

Release package ID

Example Request

POST /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/release-packages/deploy
{
  "package_ids": ["23"],
  "startup_mode": 0
}

Example Response

  • Success response

    HTTP status code 200

    {
    "deploy_package_details": [
        {
            "asy_subtask_num": 1,
            "asy_task_id": "ff8080818c81c8ab018c8b43f85d0008",
            "package_id": 23
        }
    ]
}
  • Failure response

    HTTP status code 400

    {
  "error_code": "DLF.0810",
  "error_msg": "Task does not exist."
}
Parent Topic: Job Development APIs