Manage Dedicated Deployments with an API

HTTP API を使用して専用デプロイメントを管理します。

注意：

すべてのエンドポイントは以下でホストされています https://roboflow.cloud.
レスポンスコードを確認してください：
- もしそれが 200であれば、レスポンスボディをJSONオブジェクトとしてデコードしてください。
- それ以外の場合、レスポンスボディは文字列としてのエラーメッセージを含みます。

POST /add — Dedicated Deployment を作成する

リクエストボディ例（json）

{
	"api_key": API_KEY,
	"deployment_name": "dev-testing",
	"machine_type": "dev-gpu",
	"creator_email": YOUR_EMAIL_ADDRESS,
	"duration": 3.0,
	"inference_version": "latest",
	"min_replicas": 1,
	"max_replicas": 1
}

リクエストボディスキーマ（json）

api_key（string）：必須
deployment_name（string）：必須
machine_type（string）：必須
creator_email（string）：必須
duration（float）：任意、単位は時間。デフォルトは 3
inference_version（string）：任意、デフォルトは latest
min_replicas（integer）：任意、デフォルトは 1
max_replicas（integer）：任意、デフォルトは 1

レスポンス例（json）

{
	"deployment_id": "IwzJ5YLQ0iDhwzqoh3Ae",
	"deployment_name": "dev-testing",
	"machine_type": "dev-gpu",
	"creator_email": YOUR_EMAIL_ADDRESS,
	"creator_id": YOUR_USER_ID,
	"subdomain": "dev-testing",
	"domain": "dev-testing.roboflow.cloud",
	"duration": 3.0,
	"inference_version": "0.45.0",
	"max_replicas": 1,
	"min_replicas": 1,
	"num_replicas": 0,
	"status": "pending",
	"workspace_id": YOUR_WORKSPACE_ID,
	"workspace_url": YOUR_WORKSPACE_URL
}

レスポンススキーマ（json）

deployment_id（string）：一意の識別子
deployment_name（string）
machine_type（string）
creator_email（string）
creator_id（string）：対応するユーザーID（creator_emailに該当） creator_email
subdomain（string）：必ずしも deployment_nameと同じではありません。サブドメインが既に使用されている場合、サフィックスを追加します
domain（string）
duration（float）
inference_version（string）
min_replicas（integer）
max_replicas（integer）
num_replicas（integer）：現在利用可能なレプリカ数
status（string）
workspace_id（string）
workspace_url（string）

GET /list — ワークスペース内の Dedicated Deployment を一覧表示する

Query Parameters

api_key（string）：必須
show_expired（string）：任意、デフォルトは false
show_deleted（string）：任意、デフォルトは false

レスポンス例（json）

[
{
	"deployment_id": "IwzJ5YLQ0iDhwzqoh3Ae",
	"deployment_name": "dev-testing",
	"machine_type": "dev-gpu",
	"creator_email": YOUR_EMAIL_ADDRESS,
	"creator_id": YOUR_USER_ID,
	"subdomain": "dev-testing",
	"domain": "dev-testing.roboflow.cloud",
	"duration": 3.0,
	"inference_version": "0.45.0",
	"max_replicas": 1,
	"min_replicas": 1,
	"num_replicas": 0,
	"status": "pending",
	"workspace_id": YOUR_WORKSPACE_ID,
	"workspace_url": YOUR_WORKSPACE_URL
}
]

レスポンススキーマ（json）

Dedicated Deployment エントリのリスト。各エントリは /add のスキーマと同じです。

GET /get — Dedicated Deployment の詳細を取得する

Query Parameters

api_key（string）：必須
deployment_name（string）：必須

レスポンス例（json）

{
	"deployment_id": "IwzJ5YLQ0iDhwzqoh3Ae",
	"deployment_name": "dev-testing",
	"machine_type": "dev-gpu",
	"creator_email": YOUR_EMAIL_ADDRESS,
	"creator_id": YOUR_USER_ID,
	"subdomain": "dev-testing",
	"domain": "dev-testing.roboflow.cloud",
	"duration": 3.0,
	"inference_version": "0.45.0",
	"max_replicas": 1,
	"min_replicas": 1,
	"num_replicas": 0,
	"status": "pending",
	"workspace_id": YOUR_WORKSPACE_ID,
	"workspace_url": YOUR_WORKSPACE_URL
}

レスポンススキーマ（json）

レスポンスのスキーマと同じです（GET /get の応答） /add のスキーマと同じです。

GET /get_log — Dedicated Deployment のログを取得する

Query Parameters

api_key（string）：必須
deployment_name（string）：必須
max_entries（integer）：任意、デフォルトは50
from_timestamp（string）：任意、形式は ISO 8601 形式、デフォルトは現在時刻の1時間前です
to_timestamp（string）：任意、形式は ISO 8601 形式、デフォルトは現在時刻です

レスポンス例（json）

[
	{
		"insert_id": "gpwrgrw55p7b9jdq",
		"payload": "INFO:     10.18.0.38:46296 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:23:14.209436+00:00"
	},
	{
		"insert_id": "mbieh16zdjvqp81j",
		"payload": "INFO:     10.18.0.38:46294 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:23:14.208738+00:00"
	},
	{
		"insert_id": "0odfnfwh8ts6e4jt",
		"payload": "INFO:     10.18.0.38:54650 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:22:14.209054+00:00"
	},
	{
		"insert_id": "s3nabhyhejuke6ub",
		"payload": "INFO:     10.18.0.38:54640 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:22:14.208329+00:00"
	},
	{
		"insert_id": "2cz5u3jx4ma22tl8",
		"payload": "INFO:     10.18.0.38:40264 - \"GET /info HTTP/1.1\" 200 OK",
		"severity": "INFO",
		"timestamp": "2025-01-22T13:21:14.209900+00:00"
	}
]

レスポンススキーマ（json）

ログエントリのリスト。各エントリは以下の属性を持ちます：

insert_id（string）：各ログエントリの一意の識別子
payload（string）：ログ内容
severity（string）
timestamp（string）

POST /pause — Dedicated Deployment を一時停止する

リクエストボディ例（json）

{
	"api_key": API_KEY,
	"deployment_name": "dev-testing"
}

リクエストボディスキーマ（json）

api_key（string）：必須
deployment_name（string）：必須

レスポンス例（json）

{
	"message": "OK"
}

レスポンススキーマ

message（string）

POST /resume — Dedicated Deployment を再開する

リクエストボディ例（json）

{
	"api_key": API_KEY,
	"deployment_name": "dev-testing"
}

リクエストボディスキーマ（json）

api_key（string）：必須
deployment_name（string）：必須

レスポンス例（json）

{
	"message": "OK"
}

レスポンススキーマ

message（string）

POST /delete — Dedicated Deployment を削除する

リクエストボディ例（json）

{
	"api_key": API_KEY,
	"deployment_name": "dev-testing"
}

リクエストボディスキーマ（json）

api_key（string）：必須
deployment_name（string）：必須

レスポンス例（json）

{
	"message": "OK"
}

レスポンススキーマ

message（string）

PreviousMake Requests to a Dedicated Deployment NextSelf-Hosted Deployment

Last updated 8 months ago

Was this helpful?