Skip to content

工作 (Job)

取得單一工作資訊 (/get-job)

使用範例

呼叫API：

curl --request GET 'https://api.raas.kklab.com/get-job?project_id=$PROJECT_ID&job_id=$JOB_ID' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY'

import requests
from pprint import pprint

headers = create_headers(scopes=["/get-job"])

url = "https://api.raas.kklab.com/get-job"

params = {
    "project_id": "$PROJECT_ID",
    "job_id": "$JOB_ID"
}

response = requests.request("GET", url, headers=headers, params=params)

pprint(response.json())

回傳值：

{
    "project_id": "$PROJECT_ID",
    "job_id": "$JOB_ID",
    "job_type": "TRAINING",
    "created_ts": 1624341750746,
    "name": "my trining job",
    "job_data": {},
    "job_result": {},
    "job_status": "SUCCEED",
    "retry_count": 0
}

欄位說明

  • job_type: 工作類型：TRAINING、DEPLOYMENT、等。
  • job_data: 工作類型的相關資料。
  • job_result: 工作結果，若未完成則為 null。
  • job_status: 工作目前的狀態，SUCCEED 代表工作已成功完成。
  • retry_count: 如有非預期的錯誤，工作會自動進行重試，最多重複三次。失敗的工作不會消耗開發者帳號的時數。

列出所有工作 (/list-jobs)

使用範例

呼叫API：

curl --request GET 'https://api.raas.kklab.com/list-jobs?project_id=$PROJECT_ID' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY'

import requests
from pprint import pprint

headers = create_headers(scopes=["/list-jobs"])

url = "https://api.raas.kklab.com/list-jobs"

params = {
    "project_id": "$PROJECT_ID"
}

response = requests.request("GET", url, headers=headers, params=params)

pprint(response.json())

回傳值：

{
    "jobs": [
        {
            "project_id": "$PROJECT_ID",
            "job_id": "$JOB_ID",
            "job_type": "TRAINING",
            "created_ts": 1624341750746,
            "name": "my trining job",
            "job_data": {},
            "job_result": {},
            "job_status": "SUCCEED",
            "retry_count": 0
        }
    ],
    "next_token": null
}

欄位說明

  • next_token: 數字，作為換頁使用，若沒有下一頁則為 null，若有下一頁，可將 next_token 傳入 HTTP GET parameter取得下一頁資料。

刪除工作 (/delete-job)

使用範例

呼叫API：

curl --request DELETE 'https://api.raas.kklab.com/delete-job' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "project_id": "$PROJECT_ID",
    "job_id": "$JOB_ID"
}'

import json
import requests
from pprint import pprint

headers = create_headers(scopes=["/delete-job"])

url = "https://api.raas.kklab.com/delete-job"

data={
    "project_id": "$PROJECT_ID",
    "job_id": "$JOB_ID"
}

response = requests.request("DELETE", url, headers=headers, data=json.dumps(data))

pprint(response.json())

回傳值：

{
    "project_id": "$PROJECT_ID",
    "job_id": "$JOB_ID",
    "job_type": "TRAINING",
    "created_ts": 1624341750746,
    "name": "my trining job",
    "job_data": {},
    "job_result": {},
    "job_status": "SUCCEED",
    "retry_count": 0
}

API回傳該工作被刪除前的最後設定。

限制與注意事項

  • 無法刪除正在執行的工作。