logo
API docs by Redocly

非同期タスク処理サーバーが公開するAPI (1.0.0)

Download OpenAPI specification:Download

DX Suite は、開発者がアプリケーションで利用できるように、以下の API を公開しています。

推論環境

推論環境を新規に作成するAPI

認可チェックが実施される

Request Body schema: multipart/form-data
auto_scaling_enabled
boolean (オートスケーリングの有効/無効)

true 有効、false 無効

auto_scaling_max_replicas
integer (オートスケーリング有効時の最大インスタンス数)

example: 5

desired_capacity
integer <binary> (常時稼働させるインスタンス数)

example: 4

servable_id
string (学習モデルのID)

servable_id とは、学習モデルのID（Intelligence service管理）。
これを推論に使用します。
example: randomstring

server_plan
string (サーバープラン)

example 指定可能な値は、basic、standard、gpu_basic

Responses

Response samples

Content type
application/json
{
  • "endpoints": [
    ],
  • "env_id": 1,
  • "msg": "",
  • "version": 1
}

推論環境を削除するAPI

認可チェックが実施される

Request Body schema: application/json
env_id
integer (env_id)

example: 1
削除対象の推論環境ID

Responses

Request samples

Content type
application/json
{
  • "env_id": 0
}

Response samples

Content type
application/json
{
  • "env_id": 1,
  • "msg": ""
}

推論環境ステータス取得API

推論ステータスの設定内容、状態を取得するAPI
認可チェックが実施される

path Parameters
env_id
required
integer (推論環境ID)

Responses

Response samples

Content type
application/json
{
  • "env_id": 1,
  • "msg": ""
}

既存の推論環境の設定を更新するAPI

認可チェックが実施される

Request Body schema: application/json
auto_scaling_enabled
boolean (オートスケーリングの有効/無効。true 有効、false 無効)

example: true

auto_scaling_max_replicas
integer (オートスケーリング有効時の最大インスタンス数)

example: 5

desired_capacity
integer (常時稼働させるインスタンス数)

example: 1

env_id
integer (更新対象の推論環境ID)

example: 1

servable_id
string (学習モデルのID)

example: randomstring
servable_id とは、学習モデルのID（Intelligence service管理）。これを推論に使用します。

server_plan
string (サーバープラン)

example: gpu_basic
サーバープラン。指定可能な値は、basic、standard、gpu_basic

Responses

Request samples

Content type
application/json
{
  • "auto_scaling_enabled": true,
  • "auto_scaling_max_replicas": 0,
  • "desired_capacity": 0,
  • "env_id": 0,
  • "servable_id": "string",
  • "server_plan": "string"
}

Response samples

Content type
application/json
{
  • "env_id": 1,
  • "msg": ""
}

スケジュール

スケジュール

登録済みのワークフロー情報を取得します。

query Parameters
folderId
string (フォルダID)

複数をカンマ区切りで指定可能。

workflowName
string (ワークフロー名)

指定した文字列に完全一致するワークフローを検索します。日本語で設定する場合は、URLエンコードして設定します。

スケジュール作成API

スケジュールを新規に作成するAPI
認可チェックが実施される。
作成済みの他のスケジュールの開始日時と同じ開始日時のスケジュールを作成することはできない。

path Parameters
env_id
required
integer (推論環境ID)
Request Body schema: application/json
auto_scaling_enabled
boolean (オートスケーリングの有効/無効(true/false))
auto_scaling_max_replicas
integer (オートスケーリング有効時の最大インスタンス数)
day_of_week
string (繰り返しの曜日の指定)

example: mon
mon,tue,wed,thu,fri,sat,sun または0-6の整数

dd
string (繰り返しの日の指定 1-31の整数)

example: 31

desired_capacity
integer (維持するインスタンス数（オートスケーリング有効時は最小インスタンス数）)

example: 1

end_time
string (スケジュールの終了日時（分まで指定可能）)

example: 2023-03-14 17:03

hh
string (繰り返しの時の指定 0-23の整数)

example: 23

mi
string (繰り返しの分の指定 0-59の整数)

example: 59

mm
string (繰り返しの月の指定 1-12の整数)

example: 12

schedule_type
string (スケジュールタイプ １回限り once あるいは 繰り返し hourly/daily/monthly/yearly/weekly のいずれか１つ指定可能)

example: once

start_time
string (スケジュールの開始日時)

example: 2023-03-13 17:03
スケジュールの開始日時（分まで指定可能）１回限りの場合、この時間にアクションが実行される。繰り返しの場合、開始時間から繰り返しが有効になり、繰り返しの設定に基づいてアクションが実行される。

Responses

Request samples

Content type
application/json
{
  • "auto_scaling_enabled": true,
  • "auto_scaling_max_replicas": 0,
  • "day_of_week": "string",
  • "dd": "string",
  • "desired_capacity": 0,
  • "end_time": "string",
  • "hh": "string",
  • "mi": "string",
  • "mm": "string",
  • "schedule_type": "string",
  • "start_time": "string"
}

Response samples

Content type
application/json
{
  • "env_id": 1,
  • "msg": ""
}

スケジュール削除API

スケジュールを削除するAPI
認可チェックが実施される。

path Parameters
env_id
required
integer (推論環境ID)
Request Body schema: multipart/form-data
schedule_id
integer (削除対象のスケジュールID)

example: 1

Responses

Response samples

Content type
application/json
{
  • "env_id": 1,
  • "msg": ""
}

スケジュール更新API

作成済みのスケジュールの内容を更新するAPI
認可チェックが実施される。
作成済みの他のスケジュールの開始日時と同じ開始日時のスケジュールを作成することはできない。
開始日時を過ぎた１回限りのスケジュールを更新することはできない。

path Parameters
env_id
required
integer (推論環境ID)
Request Body schema: multipart/form-data
auto_scaling_enabled
boolean (オートスケーリングの有効/無効(true/false))
auto_scaling_max_replicas
integer (オートスケーリング有効時の最大インスタンス数)
day_of_week
string (繰り返しの曜日の指定)

example: mon
mon,tue,wed,thu,fri,sat,sun または0-6の整数

dd
string (繰り返しの日の指定 1-31の整数)

example: 31

desired_capacity
integer (維持するインスタンス数（オートスケーリング有効時は最小インスタンス数）)

example: 1

end_time
string (スケジュールの終了日時（分まで指定可能）)

example: 2023-03-14 17:03

hh
string (繰り返しの時の指定 0-23の整数)

example: 23

mi
string (繰り返しの分の指定 0-59の整数)

example: 59

mm
string (繰り返しの月の指定 1-12の整数)

example: 12

schedule_id
integer (スケジュールID)

example: 1

schedule_type
string (スケジュールタイプ １回限り once あるいは 繰り返し hourly/daily/monthly/yearly/weekly のいずれか１つ指定可能)

example: once

start_time
string (スケジュールの開始日時)

example: 2023-03-13 17:03
スケジュールの開始日時（分まで指定可能）１回限りの場合、この時間にアクションが実行される。繰り返しの場合、開始時間から繰り返しが有効になり、繰り返しの設定に基づいてアクションが実行される。

Responses

Response samples

Content type
application/json
{
  • "env_id": 1,
  • "msg": ""
}