Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 1.55 KB

start_task.md

File metadata and controls

50 lines (38 loc) · 1.55 KB

Functional description

Start a task

Request Parameters

General Parameters

Field Type Required Description
bk_app_code string YES APP ID
bk_app_secret string YES APP Secret(APP TOKEN), which can be got via BlueKing Developer Center -> Click APP ID -> Basic Info
bk_token string NO Current user login token, bk_token or bk_username must be valid, bk_token can be got by Cookie
bk_username string NO Current user username, APP in the white list, can use this field to specify the current user

Interface Parameters

Field Type Required Description
bk_biz_id string YES the business ID
task_id string YES the task ID

Request Parameters Example

{
    "bk_app_code": "esb_test",
    "bk_app_secret": "xxx",
    "bk_token": "xxx",
    "bk_biz_id": "2",
    "task_id": "10"
}

Return Result Example

{
    "result": true,
    "data": {}
}

Return Result Description

Field Type Description
result bool true or false, indicate success or failure
data dict data returned when result is true
message string error message returned when result is false