명령 취소

POST

/api/v1/commands/{command_id}/cancel

const url = 'https://dev.api.endueos.com/api/v1/commands/cmd_01J9ZK3Q8M4XW7D2N5R6T0V1BC/cancel';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dev.api.endueos.com/api/v1/commands/cmd_01J9ZK3Q8M4XW7D2N5R6T0V1BC/cancel \
  --header 'Authorization: Bearer <token>'

취소한다. 줄에 있으면 바로 cancelled 다 (실행되지 않았다). 에이전트에 보낸 뒤라면 cancelling 이 되고 답을 기다린다 — 되돌리기가 아니다 (이미 일어난 효과는 남는다). 끝난 명령이면 그대로 200.

가이드 — 명령

인증

파라미터

경로 파라미터

command_id

필수

string

/^cmd_[0-9A-HJKMNP-TV-Z]{26}$/

예시

cmd_01J9ZK3Q8M4XW7D2N5R6T0V1BC

응답

200

성공.

application/json

object

data

필수

명령 기록. 입력 원문은 남기지 않는다. 출력은 보관한 경우에만 output_url 로 24시간 받을 수 있다.

object

command_id

필수

string

/^cmd_[0-9A-HJKMNP-TV-Z]{26}$/

request_id

필수

string

resource_id

필수

string

/^res_[0-9A-HJKMNP-TV-Z]{26}$/

agent_id

필수

string

/^agnt_[0-9A-HJKMNP-TV-Z]{26}$/

station_id

필수

string

/^stn_[0-9A-HJKMNP-TV-Z]{26}$/

actor_type

필수

string

허용 값: user api_key

actor_id

필수

string

command

필수

string

status

필수

string

허용 값: queued dispatched running cancelling succeeded failed timed_out cancelled expired unknown

error

필수

Any of:

string
null

string

error_code

필수

Any of:

string
null

string

timeout_ms

필수

integer format: int32

queue_ttl_ms

필수

integer format: int32

duration_ms

필수

Any of:

integer
null

integer format: int64

created_at

필수

string format: date-time

dispatched_at

필수

Any of:

string
null

string format: date-time

completed_at

필수

Any of:

string
null

string format: date-time

output_url

필수

Any of:

string
null

string

output_expires_at

필수

Any of:

string
null

string format: date-time

late_status

필수

Any of:

string
null

늦게 도착한 답의 상태 — unknown 으로 끝난 뒤에 온 것.

string

허용 값: succeeded failed timed_out

late_at

필수

Any of:

string
null

string format: date-time

updated_at

필수

string format: date-time

meta

필수

object

request_id

필수

string

timestamp

필수

string format: date-time

duration

서버 처리 시간(ms).

integer format: int32

예시

{
  "data": {
    "command_id": "cmd_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "resource_id": "res_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "agent_id": "agnt_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "station_id": "stn_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "actor_type": "user",
    "status": "queued",
    "late_status": "succeeded"
  }
}

401

인증이 없거나 무효다 — UNAUTHORIZED. 본문은 오류 봉투.

404

없거나 내 것이 아니다 — *_NOT_FOUND. 본문은 오류 봉투.

429

한도를 넘었다 — Retry-After 초 뒤에 다시. 본문은 오류 봉투.

500

서버 오류 — INTERNAL_ERROR. 본문은 오류 봉투.

503

의존 서비스에 닿지 못했다 — 잠시 뒤 다시. 본문은 오류 봉투.