본 한국어 번역은 사용자 편의를 위해 제공되는 기계 번역입니다. 영어 버전과 한국어 버전이 서로 어긋나는 경우에는 언제나 영어 버전이 우선합니다.

HTTP 세부 정보

Astra Control REST API는 HTTP 및 관련 매개 변수를 사용하여 리소스 및 컬렉션에 대한 작업을 수행합니다. HTTP 구현에 대한 자세한 내용은 아래에 나와 있습니다.

API 트랜잭션 및 CRUD 모델

Astra Control REST API는 잘 정의된 작업과 상태 전환을 통해 트랜잭션 모델을 구현합니다.

모든 REST API 호출은 Astra 서비스에 대한 HTTP 요청으로 수행됩니다. 각 요청은 연결된 응답을 클라이언트에 다시 생성합니다. 이 요청 응답 쌍은 API 트랜잭션으로 간주될 수 있습니다.

Astra Control REST API를 통해 사용 가능한 각 리소스 인스턴스 및 컬렉션은 * CRUD * 모델을 기반으로 액세스합니다. 4개의 작업이 있으며, 각 작업은 단일 HTTP 메서드에 매핑됩니다. 다음과 같은 작업이 포함됩니다.

  • 생성

  • 읽기

  • 업데이트

  • 삭제

일부 Astra 리소스의 경우 이러한 작업의 일부만 지원됩니다. 를 검토해야 합니다 "API 참조입니다" 특정 API 호출에 대한 자세한 내용은 를 참조하십시오.

HTTP 메서드

API에서 지원하는 HTTP 메서드 또는 동사는 아래 표에 나와 있습니다.

방법 CRUD 설명

가져오기

읽기

리소스 인스턴스 또는 컬렉션의 개체 속성을 검색합니다. 이 작업은 컬렉션과 함께 사용할 때 * list * 연산으로 간주됩니다.

게시

생성

입력 매개 변수를 기반으로 새 리소스 인스턴스를 만듭니다. 장기간의 URL은 Location(위치) 응답 헤더로 반환됩니다.

를 누릅니다

업데이트

제공된 JSON 요청 본문으로 전체 리소스 인스턴스를 업데이트합니다. 사용자가 수정할 수 없는 키 값은 보존됩니다.

삭제

삭제

기존 리소스 인스턴스를 삭제합니다.

요청 및 응답 헤더

다음 표는 Astra Control REST API와 함께 사용되는 HTTP 헤더를 요약한 것입니다.

참고 을 참조하십시오 "RFC 7232""RFC 7233" 를 참조하십시오.
머리글 유형 사용 참고 사항

수락

요청하십시오

값이 " * / * "이거나 제공되지 않으면 Content-Type 응답 헤더에서 application/json이 반환됩니다. 값이 Astra 리소스 미디어 유형으로 설정되어 있으면 Content-Type 헤더에서 동일한 미디어 유형이 반환됩니다.

권한 부여

요청하십시오

사용자에 대한 API 키가 있는 베어러 토큰.

Content-Type(콘텐츠 유형)

응답

'수락' 요청 헤더를 기준으로 반환됩니다.

ETag

응답

RFC 7232에 정의된 대로 에 포함됩니다. 값은 전체 JSON 리소스에 대한 MD5 값의 16진수 표현입니다.

일치하는 경우

요청하십시오

3.1 RFC 7232절에 설명된 대로 구현된 전제 조건 요청 헤더와 * PUT * 요청 지원.

If-Modified-Since

요청하십시오

섹션 3.4 RFC 7232에 설명된 대로 구현된 전제 조건 요청 헤더와 * PUT * 요청 지원.

수정되지 않은 경우 - 이후

요청하십시오

섹션 3.4 RFC 7232에 설명된 대로 구현된 전제 조건 요청 헤더와 * PUT * 요청 지원.

위치

응답

새로 만든 리소스의 전체 URL을 포함합니다.

쿼리 매개 변수

다음 쿼리 매개 변수를 리소스 모음과 함께 사용할 수 있습니다. 을 참조하십시오 "컬렉션 작업" 를 참조하십시오.

쿼리 매개 변수입니다 설명

포함

컬렉션을 읽을 때 반환되어야 하는 필드를 포함합니다.

필터

컬렉션을 읽을 때 반환할 리소스에 대해 일치해야 하는 필드를 나타냅니다.

주문

컬렉션을 읽을 때 반환되는 리소스의 정렬 순서를 결정합니다.

제한

컬렉션을 읽을 때 반환되는 최대 리소스 수를 제한합니다.

건너뛰기

컬렉션을 읽을 때 전달하고 건너뛸 리소스 수를 설정합니다.

카운트

메타데이터 개체에서 총 리소스 수를 반환해야 하는지 여부를 나타냅니다.

HTTP 상태 코드입니다

Astra Control REST API에서 사용하는 HTTP 상태 코드는 아래와 같다.

참고 Astra Control REST API는 HTTP API * 표준에 대한 * Problem Details도 사용합니다. 을 참조하십시오 "진단 및 지원" 를 참조하십시오.
코드 의미 설명

200

좋습니다

새 리소스 인스턴스를 만들지 않는 호출의 성공 여부를 나타냅니다.

201

작성됨

객체가 성공적으로 생성되고 위치 응답 헤더에 객체의 고유 식별자가 포함됩니다.

204

콘텐츠가 없습니다

반환된 콘텐츠가 없지만 요청이 성공했습니다.

400

잘못된 요청입니다

요청 입력이 인식되지 않거나 부적절합니다.

401

권한이 없습니다

사용자에게 권한이 없으며 인증이 필요합니다.

403

금지됨

인증 오류로 인해 액세스가 거부되었습니다.

404

찾을 수 없습니다

요청에서 참조되는 리소스가 없습니다.

409

충돌

개체가 이미 있으므로 개체를 만들지 못했습니다.

500입니다

내부 오류입니다

서버에서 일반적인 내부 오류가 발생했습니다.

503

서비스를 사용할 수 없습니다

어떤 이유로 요청을 처리할 준비가 되지 않았습니다.