メインコンテンツまでスキップ
Glows.ai
API docs by Redocly

Glows.ai SDK API ドキュメント (1.0.1)

Glows.ai SDK の API ドキュメント

SDK API

コンピュートインスタンスの管理：起動、取得、解放、統計、一覧。

インスタンスを起動

SDK を使用して新しいインスタンスを起動します

Authorizations:
bearerAuth
Request Body schema: application/json
required
One of
from_image_id
required
string

イメージ ID。例：6np5yvq2

gpu_name
required
string

GPU マシン名。例：NVIDIA L40S PCIe

custom_meta_key
required
string

ユーザーが設定するインスタンスの一意識別子（インスタンス ID とは別）

instance_category
required
string

マシンの基盤技術タイプ。例：container、vm

region_name
required
string

マシンのリージョン。例：TW-03、TW-04 など。

remark
string

ユーザーが設定するインスタンスの備考名

public_ip_id
string

バインドする Public IP に対応する ID。例：net-abcdefg

envs
string

デフォルトの環境変数。例：foo=bar;tik=tok

ports
string

カスタム公開ポート。JSON 文字列形式。例：[{"port":7890,"protocol":2}, {"port":3306,"protocol":1}]。protocol=1 は SSH プロトコル、protocol=2 は HTTP プロトコルを表します

cmd
string

エントリーコマンド。container モードのみサポート。コマンドは継続実行可能（hang できる）である必要があります。そうでない場合、コマンド終了後にインスタンスは自動的に解放されます。例：python -m http.server 8080

Responses

Response Schema: application/json
code
integer

戻りコード。0 は成功、それ以外（非 0）は失敗を表します

msg
string

返却メッセージ。通常は失敗時の説明

object

Request samples 

curl --http1.1 \
  --request POST \
  --url 'https://a.glows.ai/sdk/v1/instance' \
  --header 'Authorization: Bearer YOUR_SDK_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "from_snap_id": "6ypgvgpw",
    "custom_meta_key": "cpu_test.009",
    "cpu_name": "Intel(R) Xeon(R) Platinum 8468",
    "instance_category": "container",
    "region_name": "TW-04",
    "public_ip_id": "net-abcdefg"
  }'

Response samples

Content type
application/json
{
  • "code": 0,
  • "msg": "",
  • "instance": {
    }
}

インスタンス情報を取得

指定したインスタンスの情報を取得します

Authorizations:
bearerAuth
query Parameters
request_id
string

インスタンス ID（インスタンス作成応答の instanceID）。request_id または meta_key のいずれかが必須です。

meta_key
string

インスタンス作成時に指定した meta_key。グローバルで一意。request_id または meta_key のいずれかが必須です。

Responses

Response Schema: application/json
code
integer

戻りコード。0 は成功、それ以外（非 0）は失敗を表します

msg
string

返却メッセージ。通常は失敗時の説明

object

Request samples 

curl --http1.1 \
  --request GET \
  --url 'https://a.glows.ai/sdk/v1/instance?meta_key=cpu_test.009' \
  --header 'Authorization: Bearer YOUR_SDK_TOKEN'

Response samples

Content type
application/json
{
  • "code": 0,
  • "msg": "",
  • "instance": {
    }
}

インスタンスを解放

request_id または meta_key を使用してインスタンスを解放します

Authorizations:
bearerAuth
query Parameters
request_id
string

インスタンス ID（インスタンス作成応答の instanceID）。request_id または meta_key のいずれかが必須です。

meta_key
string

インスタンス作成時に指定した meta_key。グローバルで一意。request_id または meta_key のいずれかが必須です。

Responses

Response Schema: application/json
code
integer

戻りコード。0 は成功、それ以外（非 0）は失敗を表します

msg
string

返却メッセージ。通常は失敗時の説明

Request samples 

curl --http1.1 \
  --request DELETE \
  --url 'https://a.glows.ai/sdk/v1/instance?meta_key=cpu_test.009' \
  --header 'Authorization: Bearer YOUR_SDK_TOKEN'

Response samples

Content type
application/json
{
  • "code": 0,
  • "msg": ""
}

インスタンス統計

インスタンスの統計情報を取得します

Authorizations:
bearerAuth

Responses

Response Schema: application/json
code
integer

戻りコード。0 は成功、それ以外（非 0）は失敗を表します

msg
string

返却メッセージ。通常は失敗時の説明

object

各ステータスに対応するインスタンス数。統計値が 0 のステータスは表示されません

Request samples 

curl --http1.1 \
  --request GET \
  --url 'https://a.glows.ai/sdk/v1/instance/stats' \
  --header 'Authorization: Bearer YOUR_SDK_TOKEN'

Response samples

Content type
application/json
{
  • "code": 0,
  • "msg": "",
  • "stats": {
    }
}

インスタンス一覧

ページネーションとフィルタリングのオプションでインスタンス一覧を取得します

Authorizations:
bearerAuth
query Parameters
page
required
integer

ページ番号

per_page
required
integer

1 ページあたりの件数

ascending
boolean

作成日時の昇順で取得するかどうか。デフォルトは降順です

statuses
Array of strings

指定したステータスのインスタンスのみを表示します

Responses

Response Schema: application/json
code
integer

戻りコード。0 は成功、それ以外（非 0）は失敗を表します

msg
string

返却メッセージ。通常は失敗時の説明

object
Array of objects

Request samples 

curl --http1.1 \
  --request GET \
  --url 'https://a.glows.ai/sdk/v1/instance/list?page=1&per_page=10&statuses=Running' \
  --header 'Authorization: Bearer YOUR_SDK_TOKEN'

Response samples

Content type
application/json
{
  • "code": 0,
  • "msg": "",
  • "pagination": {
    },
  • "instances": [ ]
}

LLM

ドキュメントは近日公開予定です。

Skills

ドキュメントは近日公開予定です。