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

그리드 관리 API 사용

PDF

Grid Manager 사용자 인터페이스 대신 Grid Management REST API를 사용하여 시스템 관리 작업을 수행할 수 있습니다. 예를 들어, API를 사용하여 작업을 자동화하거나 사용자와 같은 여러 엔터티를 더 빠르게 생성할 수 있습니다.

최상위 리소스

그리드 관리 API는 다음과 같은 최상위 리소스를 제공합니다.

  • /grid: 액세스는 Grid Manager 사용자에게만 제한되며 구성된 그룹 권한에 따라 결정됩니다.

  • /org: 테넌트 계정에 대한 액세스는 로컬 또는 페더레이션 LDAP 그룹에 속한 사용자로 제한됩니다. 자세한 내용은 다음을 참조하십시오. "세입자 계정 사용" .

  • /private: 액세스는 Grid Manager 사용자에게만 제한되며 구성된 그룹 권한에 따라 결정됩니다. 비공개 API는 사전 고지 없이 변경될 수 있습니다. StorageGRID 개인 엔드포인트는 요청의 API 버전도 무시합니다.

API 요청 발행

그리드 관리 API는 Swagger 오픈 소스 API 플랫폼을 사용합니다. Swagger는 개발자와 비개발자 모두 API를 사용하여 StorageGRID 에서 실시간 작업을 수행할 수 있는 직관적인 사용자 인터페이스를 제공합니다.

Swagger 사용자 인터페이스는 각 API 작업에 대한 전체 세부 정보와 설명서를 제공합니다.

시작하기 전에
주의 API 문서 웹페이지를 사용하여 수행하는 모든 API 작업은 실시간 작업입니다. 실수로 구성 데이터나 기타 데이터를 생성, 업데이트 또는 삭제하지 않도록 주의하세요.
단계

  1. 그리드 관리자 헤더에서 도움말 아이콘을 선택하고 *API 설명서*를 선택합니다.

    도움말 메뉴

  2. 비공개 API로 작업을 수행하려면 StorageGRID 관리 API 페이지에서 *비공개 API 문서로 이동*을 선택하세요.

    비공개 API는 사전 고지 없이 변경될 수 있습니다. StorageGRID 개인 엔드포인트는 요청의 API 버전도 무시합니다.

  3. 원하는 작업을 선택하세요.

    API 작업을 확장하면 GET, PUT, UPDATE, DELETE와 같은 사용 가능한 HTTP 작업을 볼 수 있습니다.

  4. 요청 세부 정보(엔드포인트 URL, 필수 또는 선택 매개변수 목록, 요청 본문 예(필요한 경우), 가능한 응답 등)를 보려면 HTTP 작업을 선택하세요.

    Swagger UI의 예

  5. 요청에 그룹이나 사용자 ID와 같은 추가 매개변수가 필요한지 확인합니다. 그런 다음 이러한 값을 얻습니다. 필요한 정보를 얻으려면 먼저 다른 API 요청을 발행해야 할 수도 있습니다.

  6. 예제 요청 본문을 수정해야 하는지 확인하세요. 그렇다면 *모델*을 선택하여 각 필드의 요구 사항을 알아볼 수 있습니다.

  7. *시도해보기*를 선택하세요.

  8. 필요한 매개변수를 제공하거나, 필요에 따라 요청 본문을 수정하세요.

  9. *실행*을 선택하세요.

  10. 요청이 성공했는지 확인하려면 응답 코드를 검토하세요.