요청하신 자료를 사용할 수 없습니다. 이 버전의 제품에 적용되지 않거나 이 버전의 문서에서 관련 정보가 다르게 구성되어 있습니다. 제안 작업: 검색, 찾아보기 또는 다른 버전으로 돌아가기.

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

ONTAP tools REST API 구현 세부 정보

07/24/2026 기여자

PDF

REST는 공통된 기술과 모범 사례를 제시하지만, 각 API의 정확한 구현 방식은 설계 선택에 따라 달라질 수 있습니다. 따라서 ONTAP tools for VMware vSphere 10 REST API 설계 방식을 숙지한 후에 사용해야 합니다.

REST API에는 vCenters 및 애그리게이트와 같은 여러 리소스 범주가 포함되어 있습니다. 자세한 내용은 "API 참조"을 검토하십시오.

REST API에 액세스하는 방법

ONTAP tools for VMware vSphere 10 REST API는 포트와 함께 ONTAP tools IP 주소를 통해 액세스할 수 있습니다. 전체 URL은 다음과 같은 여러 부분으로 구성됩니다.

ONTAP tools IP 주소 및 포트
API 버전
리소스 카테고리
특정 리소스

초기 설정 시 IP 주소를 구성해야 하며, 포트는 8443으로 고정됩니다. URL의 앞부분은 각 ONTAP tools for VMware vSphere 10 인스턴스에서 동일하며, 엔드포인트 간에 리소스 범주와 특정 리소스만 변경됩니다.

아래 예시의 IP 주소와 포트 값은 설명 목적으로만 제시된 것입니다. 실제 사용 환경에 맞게 이 값을 변경해야 합니다.

인증 서비스에 액세스하는 예시

https://10.61.25.34:8443/virtualization/api/v1/auth/login

이 URL은 POST 방식을 사용하여 액세스 토큰을 요청하는 데 사용할 수 있습니다.

vCenter 서버 목록을 표시하는 예시

https://10.61.25.34:8443/virtualization/api/v1/vcenters

이 URL을 사용하면 GET 메서드를 통해 정의된 vCenter 서버 인스턴스 목록을 요청할 수 있습니다.

HTTP 세부 정보

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

HTTP 메서드

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

방법	CRUD	설명
GET	읽기	리소스 인스턴스 또는 컬렉션의 객체 속성을 검색합니다. 컬렉션과 함께 사용할 경우 목록 작업으로 간주됩니다.
POST	생성	입력 매개변수를 기반으로 새로운 리소스 인스턴스를 생성합니다.
PUT	업데이트	제공된 JSON 요청 본문을 사용하여 전체 리소스 인스턴스를 업데이트합니다. 사용자가 수정할 수 없는 주요 값은 유지됩니다.
PATCH	업데이트	요청에서 선택한 변경 사항들을 리소스 인스턴스에 적용하도록 요청합니다.
삭제	삭제	기존 리소스 인스턴스를 삭제합니다.

방법

CRUD

설명

GET

읽기

리소스 인스턴스 또는 컬렉션의 객체 속성을 검색합니다. 컬렉션과 함께 사용할 경우 목록 작업으로 간주됩니다.

POST

생성

입력 매개변수를 기반으로 새로운 리소스 인스턴스를 생성합니다.

PUT

업데이트

제공된 JSON 요청 본문을 사용하여 전체 리소스 인스턴스를 업데이트합니다. 사용자가 수정할 수 없는 주요 값은 유지됩니다.

PATCH

업데이트

요청에서 선택한 변경 사항들을 리소스 인스턴스에 적용하도록 요청합니다.

삭제

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

요청 및 응답 헤더

다음 표는 REST API에서 사용되는 가장 중요한 HTTP 헤더를 요약한 것입니다.

헤더 유형 사용 참고 사항

헤더	유형	사용 참고 사항
수락	요청	이는 클라이언트 애플리케이션이 허용할 수 있는 콘텐츠 유형입니다. 유효한 값에는 '/` 또는 `application/json`이 포함됩니다.
x-auth	요청	클라이언트 애플리케이션을 통해 요청을 보낸 사용자를 식별하는 액세스 토큰이 포함되어 있습니다.
Content-Type	응답	서버에서 `Accept` 요청 헤더를 기반으로 반환된 값입니다.

수락

요청

이는 클라이언트 애플리케이션이 허용할 수 있는 콘텐츠 유형입니다. 유효한 값에는 '*/*` 또는 `application/json`이 포함됩니다.

x-auth

요청

클라이언트 애플리케이션을 통해 요청을 보낸 사용자를 식별하는 액세스 토큰이 포함되어 있습니다.

Content-Type

응답

서버에서 Accept 요청 헤더를 기반으로 반환된 값입니다.

HTTP 상태 코드

REST API에서 사용되는 HTTP 상태 코드는 다음과 같습니다.

코드	의미	설명
200	OK	새로운 리소스 인스턴스를 생성하지 않는 호출의 경우 성공을 나타냅니다.
201	생성됨	리소스 인스턴스에 대한 고유 식별자를 가진 객체가 성공적으로 생성되었습니다.
202	수락됨	요청이 승인되었으며, 해당 요청을 처리하기 위한 백그라운드 작업이 생성되었습니다.
204	콘텐츠 없음	요청은 성공했지만 반환된 콘텐츠가 없습니다.
400	잘못된 요청	요청 입력값이 인식되지 않거나 부적절합니다.
401	무단	해당 사용자는 권한이 없으므로 인증해야 합니다.
403	금지됨	권한 오류로 인해 액세스가 거부되었습니다.
404	찾을 수 없음	요청에서 참조한 리소스가 존재하지 않습니다.
409	충돌	객체가 이미 존재하므로 객체를 생성하지 못했습니다.
500	내부 오류	서버에서 일반적인 내부 오류가 발생했습니다.

코드

의미

설명

200

새로운 리소스 인스턴스를 생성하지 않는 호출의 경우 성공을 나타냅니다.

201

생성됨

리소스 인스턴스에 대한 고유 식별자를 가진 객체가 성공적으로 생성되었습니다.

202

수락됨

요청이 승인되었으며, 해당 요청을 처리하기 위한 백그라운드 작업이 생성되었습니다.

204

콘텐츠 없음

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

400

잘못된 요청

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

401

무단

해당 사용자는 권한이 없으므로 인증해야 합니다.

403

금지됨

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

404

찾을 수 없음

요청에서 참조한 리소스가 존재하지 않습니다.

409

충돌

객체가 이미 존재하므로 객체를 생성하지 못했습니다.

500

내부 오류

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

인증

REST API에 대한 클라이언트 인증은 액세스 토큰을 사용하여 수행됩니다. 토큰 및 인증 프로세스의 주요 특징은 다음과 같습니다.

클라이언트는 ONTAP tools Manager 관리자 자격 증명(사용자 이름 및 비밀번호)을 사용하여 토큰을 요청해야 합니다.
토큰은 JSON 웹 토큰(JWT) 형식으로 구성됩니다.
각 토큰은 60분 후에 만료됩니다.
클라이언트의 API 요청에는 x-auth 요청 헤더에 토큰이 포함되어야 합니다.

"첫 번째 REST API 호출"을 참조하여 액세스 토큰을 요청하고 사용하는 예시를 확인하십시오.

동기 및 비동기 요청

대부분의 REST API 호출은 빠르게 완료되므로 동기적으로 실행됩니다. 즉, 요청이 완료되면 상태 코드(예: 200)를 반환합니다. 완료하는 데 시간이 더 오래 걸리는 요청은 백그라운드 작업을 사용하여 비동기적으로 실행됩니다.

비동기적으로 실행되는 API 호출 후 서버는 HTTP 상태 코드 202를 반환합니다. 이는 요청이 수락되었지만 아직 완료되지 않았음을 나타냅니다. 백그라운드 작업을 조회하여 성공 또는 실패 여부를 포함한 상태를 확인할 수 있습니다.

비동기 처리는 데이터 저장소 및 vVol 작업과 같은 여러 유형의 장시간 실행 작업에 사용됩니다. 자세한 내용은 Swagger 페이지의 REST API 작업 관리자 범주를 참조하십시오.