콘텐츠로 이동
endue OSDocs

createStorageLink

POST
/api/v1/storages/{storage_id}/links
curl --request POST \
  --url https://dev.api.endueos.com/api/v1/storages/wst_01J9ZK3Q8M4XW7D2N5R6T0V1BC/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "path": "example", "target_storage_id": "wst_01J9ZK3Q8M4XW7D2N5R6T0V1BC", "target_path": "example" }'

인증

섹션 제목: “인증”

파라미터

섹션 제목: “파라미터”

경로 파라미터

섹션 제목: “경로 파라미터”
storage_id
필수
string
/^wst_[0-9A-HJKMNP-TV-Z]{26}$/
예시
wst_01J9ZK3Q8M4XW7D2N5R6T0V1BC

헤더 파라미터

섹션 제목: “헤더 파라미터”
X-Idempotency-Key
string
/^[A-Za-z0-9._:-]{1,200}$/

요청 본문필수

섹션 제목: “요청 본문필수”
Media typeapplication/json
object
path
필수

이 Storage 안의 새 경로. 이미 있거나 다른 링크와 겹치면 409 STORAGE_PATH_EXISTS

string
>= 1 characters <= 4096 characters
target_storage_id
필수
string
/^wst_[0-9A-HJKMNP-TV-Z]{26}$/
예시
wst_01J9ZK3Q8M4XW7D2N5R6T0V1BC
target_path

생략하면 대상 Storage 의 루트

string
>= 1 characters <= 4096 characters

응답

섹션 제목: “응답”

201

섹션 제목: “201”

만들었다.

Media typeapplication/json
object
data
필수

링크는 읽고 쓸 수 있다. 링크로 쓴 내용은 대상 Storage 에 저장되고, 같은 파일은 나중 저장이 이긴다

object
link_id
필수
string
/^wsl_[0-9A-HJKMNP-TV-Z]{26}$/
storage_id
필수
string
/^wst_[0-9A-HJKMNP-TV-Z]{26}$/
path
필수
string
>= 1 characters <= 4096 characters
target_storage_id
필수
string
/^wst_[0-9A-HJKMNP-TV-Z]{26}$/
target_path
필수
string
target_kind
필수
string
허용 값: file directory
state
필수
string
허용 값: active broken
broken_reason
필수
Any of:
string
허용 값: target_path_missing target_storage_deleted
target_revision
필수
Any of:
integer format: int64
<= 9007199254740991
target_committed_at
필수
Any of:
string format: date-time
materialized
필수
Any of:
object
workspace_id
필수
string
/^wsp_[0-9A-HJKMNP-TV-Z]{26}$/
revision
필수
integer format: int64
<= 9007199254740991
synced_at
필수
string format: date-time
created_at
필수
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": {
    "link_id": "wsl_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "storage_id": "wst_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "target_storage_id": "wst_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "target_kind": "file",
    "state": "active",
    "broken_reason": "target_path_missing",
    "materialized": {
      "workspace_id": "wsp_01J9ZK3Q8M4XW7D2N5R6T0V1BC"
    }
  }
}

400

섹션 제목: “400”

요청 형식이 틀렸다 — VALIDATION_ERROR(details.errors[]) 또는 BAD_REQUEST. 본문은 오류 봉투.

401

섹션 제목: “401”

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

404

섹션 제목: “404”

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

409

섹션 제목: “409”

지금 상태와 충돌한다 — 코드는 위 설명을 본다. 본문은 오류 봉투.

422

섹션 제목: “422”

형식은 맞지만 할 수 없다 — 코드는 위 설명을 본다. 본문은 오류 봉투.

429

섹션 제목: “429”

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

500

섹션 제목: “500”

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

503

섹션 제목: “503”

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