curl 또는 프로그래밍 언어를 통해 ONTAP REST API에 직접 액세스할 수 있습니다. 이 경우 기본 URL이 ONTAP 온라인 설명서 또는 System Manager에 액세스할 때 사용하는 URL과 다릅니다.

API에 직접 액세스할 때 도메인 또는 IP 주소에 * API * 를 추가해야 합니다. 예를 들면 다음과 같습니다.

https://ontap.demo-example.com/api

을 참조하십시오 "ONTAP REST API 액세스 방법" 를 참조하십시오.

대부분의 REST API 호출에서 일반적으로 사용되는 몇 가지 입력 매개 변수가 있습니다. 이러한 매개 변수는 일반적으로 개별 워크플로에 설명되어 있지 않습니다. 매개 변수에 대해 잘 알고 있어야 합니다. 을 참조하십시오 "API 요청을 제어하는 입력 변수입니다" 를 참조하십시오.

특정 REST API 호출에 추가 매개 변수가 필요한 경우 각 워크플로에 대한 curl 예제에 대한 추가 입력 매개 변수 * 섹션에 해당 매개 변수가 포함됩니다.

워크플로우 예제에 사용되는 ID 값과 기타 변수는 불투명하며 ONTAP 클러스터마다 다를 수 있습니다. 예제의 가독성을 높이기 위해 실제 값은 사용되지 않습니다. 변수가 대신 사용됩니다. 일관된 형식과 예약된 이름을 기반으로 하는 이 접근 방식은 다음과 같은 이점을 제공합니다.

변수 형식은 Bash 셸 환경에서 사용하도록 지정됩니다. 각 변수는 달러 기호로 시작하고 필요에 따라 큰따옴표로 묶습니다. 그러면 Bash에서 인식할 수 있습니다. 대문자는 이름에 일관되게 사용됩니다.

다음은 일반적인 변수 키워드 중 일부입니다. 이 목록은 완전하지 않으며 필요에 따라 추가 변수가 사용됩니다. 그들의 의미는 상황에 따라 분명해야 합니다.

POST 또는 패치를 사용하는 경우와 같은 일부 REST API 호출에는 요청 본문에 JSON 입력이 필요합니다. JSON 입력 예는 명확한 구별을 위해 컬링 예와 별도로 제시됩니다. JSON 입력 예제를 아래 설명된 기술 중 하나와 함께 사용할 수 있습니다.

JSON 입력 예제를 파일로 복사하여 로컬에 저장할 수 있습니다. curl 명령은 를 사용하는 파일을 참조합니다 --data 로 파일 이름을 나타내는 값을 가진 매개 변수입니다 @ 접두어.

먼저 컬을 복사하여 터미널 쉘에 붙여 넣어야 합니다. 그런 다음 예제를 편집하여 를 완전히 제거합니다 --data 끝에 매개 변수를 지정하고 로 바꿉니다 --data-raw 매개 변수. 마지막으로, 업데이트된 매개 변수가 있는 curl 명령 다음에 오도록 JSON 예제에 복사하여 붙여 넣습니다. 하나의 따옴표를 사용하여 JSON 입력 예제를 래핑해야 합니다.

기본 인증을 사용할 때는 각 HTTP 요청에 사용자 자격 증명을 포함해야 합니다. 자격 증명을 보내는 방법에는 두 가지가 있습니다.

수동으로 권한 부여 헤더를 생성하고 HTTP 요청에 포함할 수 있습니다. 이는 CLI에서 curl 명령을 사용하거나 자동화 코드와 함께 프로그래밍 언어를 사용할 때 수행할 수 있습니다. 개괄적인 단계는 다음과 같습니다.

워크플로 컬링 예제에는 사용하기 전에 업데이트해야 하는 * $BASIC_AUTH * 변수가 있는 이 헤더가 포함됩니다.

curl을 사용할 때 다른 옵션은 권한 부여 헤더를 제거하고 대신 curl * user * 매개 변수를 사용하는 것입니다. 예를 들면 다음과 같습니다.

--user username:password

사용자 환경에 적합한 자격 증명을 대체해야 합니다. 자격 증명은 base64로 인코딩되지 않습니다. 이 매개 변수를 사용하여 curl 명령을 실행하면 문자열이 인코딩되고 Authorization 헤더가 생성됩니다.

OAuth 2.0을 사용하는 경우 외부 인증 서버에서 액세스 토큰을 요청하고 각 HTTP 요청에 포함시켜야 합니다. 기본적인 상위 단계는 아래에 설명되어 있습니다. 도 참조하십시오 "ONTAP OAuth 2.0 구축 개요" OAuth 2.0에 대한 자세한 내용 및 ONTAP와 함께 사용하는 방법

REST API를 사용하여 ONTAP에 액세스하기 전에 ONTAP 환경을 준비하고 구성해야 합니다. 상위 수준에서는 다음과 같은 단계가 포함됩니다.

ONTAP 및 인증 서버가 정의되고 활성화되어 있으면 OAuth 2.0 토큰을 사용하여 REST API 호출을 수행할 수 있습니다. 첫 번째 단계는 인증 서버에서 액세스 토큰을 요청하는 것입니다. 이 작업은 서버에 기반한 여러 가지 다른 기술 중 하나를 사용하여 ONTAP 외부에서 수행됩니다. ONTAP는 액세스 토큰을 발급하거나 리디렉션을 수행하지 않습니다.

액세스 토큰을 얻은 후 권한 부여 헤더를 생성하고 HTTP 요청에 포함할 수 있습니다. curl 또는 프로그래밍 언어를 사용하여 REST API에 액세스하든 관계없이 모든 클라이언트 요청에 헤더를 포함해야 합니다. 다음과 같이 헤더를 생성할 수 있습니다.

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSld …​