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（文字列）：必須
deployment_name（文字列）：必須
machine_type（文字列）：必須
creator_email（文字列）：必須
duration（浮動小数点）：オプション、単位は時間。デフォルトは 3

inference_version（文字列）：オプション、デフォルトは latest

min_replicas（整数）：オプション、デフォルトは 1
max_replicas（整数）：オプション、デフォルトは 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（文字列）：一意の識別子
deployment_name（文字列）
machine_type（文字列）
creator_email（文字列）
creator_id（文字列）： creator_email に対応するユーザーID

subdomain（文字列）：必ずしも deployment_nameと同じとは限りません。すでにサブドメインが使用されている場合はサフィックスを追加します
domain（文字列）
duration（浮動小数点）
inference_version（文字列）

min_replicas（整数）
max_replicas（整数）
num_replicas（整数）：現在利用可能なレプリカ数
status（文字列）
workspace_id（文字列）
workspace_url（文字列）

GET /list — ワークスペース内のDedicated Deployment一覧

クエリパラメータ

api_key（文字列）：必須
show_expired（文字列）：オプション、デフォルトは false
show_deleted（文字列）：オプション、デフォルトは 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の詳細を取得

クエリパラメータ

api_key（文字列）：必須
deployment_name（文字列）：必須

レスポンス例（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）

レスポンスと同じスキーマ /add エンドポイントで記載されたスキーマと同じです。

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

クエリパラメータ

api_key（文字列）：必須
deployment_name（文字列）：必須
max_entries（整数）：オプション、デフォルトは50
from_timestamp（文字列）：オプション、 ISO 8601 形式、デフォルトは現在時刻の1時間前
to_timestamp（文字列）：オプション、 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（文字列）：各ログエントリの一意の識別子
payload（文字列）：ログ内容
severity（文字列）
timestamp（文字列）

POST /pause — Dedicated Deploymentを一時停止

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

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

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

api_key（文字列）：必須
deployment_name（文字列）：必須

レスポンス例（json）

{
	"message": "OK"
}

レスポンススキーマ

message（文字列）

POST /resume — Dedicated Deploymentを再開

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

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

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

api_key（文字列）：必須
deployment_name（文字列）：必須

レスポンス例（json）

{
	"message": "OK"
}

レスポンススキーマ

message（文字列）

POST /delete — Dedicated Deploymentを削除

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

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

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

api_key（文字列）：必須
deployment_name（文字列）：必須

レスポンス例（json）

{
	"message": "OK"
}

レスポンススキーマ

message（文字列）

PreviousMake Requests to a Dedicated Deployment NextSelf-Hosted Deployment

Last updated 4 months ago

Was this helpful?