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

subdomain (string): 항상 deployment_name과 같지 않으며, 이미 사용 중인 경우 접미사가 추가됩니다
domain (string)
duration (float)
inference_version (string)

min_replicas (integer)
max_replicas (integer)
num_replicas (integer): 현재 사용 가능한 replica 수
status (string)
workspace_id (string)
workspace_url (string)

GET /list — 내 Workspace의 Dedicated Deployments 목록 조회

쿼리 파라미터

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의 상세 정보 조회

쿼리 파라미터

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)

응답과 동일한 스키마를 가집니다 /add 엔드포인트.

GET /get_log — Dedicated Deployment의 로그 조회

쿼리 파라미터

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)

Previous전용 배포에 요청 보내기 Next셀프 호스팅 배포

Last updated 4 months ago

Was this helpful?