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

테넌트 관리 API 이해

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

테넌트 관리 API:

  • Swagger 오픈 소스 API 플랫폼을 사용합니다. Swagger는 개발자와 개발자가 아닌 사용자가 API와 상호 작용할 수 있는 직관적인 사용자 인터페이스를 제공합니다. Swagger 사용자 인터페이스는 각 API 작동에 대한 전체 세부 정보와 문서를 제공합니다.

  • 사용 무중단 업그레이드를 지원하는 버전 관리.

테넌트 관리 API에 대한 Swagger 문서에 액세스하려면 다음을 수행합니다.

단계
  1. 테넌트 관리자에 로그인합니다.

  2. 테넌트 관리자 상단에서 도움말 아이콘을 선택하고 * API Documentation * 을 선택합니다.

API 작업

테넌트 관리 API는 사용 가능한 API 작업을 다음 섹션으로 구성합니다.

  • * 계정 * — 스토리지 사용 정보를 가져오는 것을 포함하여 현재 테넌트 계정의 작업입니다.

  • * auth * — 사용자 세션 인증을 수행하기 위한 작업.

    Tenant Management API는 Bearer Token Authentication Scheme을 지원합니다. 테넌트 로그인의 경우 인증 요청의 JSON 본문에 사용자 이름, 암호 및 accountId를 입력합니다(즉, 'POST/API/v3/authorize'). 사용자가 성공적으로 인증되면 보안 토큰이 반환됩니다. 이 토큰은 후속 API 요청 헤더("Authorization: Bearer token")에 제공되어야 합니다.

    인증 보안 개선에 대한 자세한 내용은 을 참조하십시오 사이트 간 요청 위조 방지.

    참고 StorageGRID 시스템에서 SSO(Single Sign-On)가 활성화된 경우 인증을 위해 다른 단계를 수행해야 합니다. 를 참조하십시오 Grid Management API 사용 지침.
  • * config * — 제품 릴리스 및 테넌트 관리 API 버전과 관련된 작업. 제품 릴리스 버전과 해당 릴리스에서 지원하는 API의 주요 버전을 나열할 수 있습니다.

  • * 컨테이너 * — S3 버킷 또는 Swift 컨테이너에서 다음과 같은 작업을 수행합니다.

  • S3 *

    • 버킷 생성(S3 오브젝트 잠금이 활성화된 상태 및 활성화되지 않은 상태)

    • 버킷 기본 보존 수정(S3 오브젝트 잠금이 활성화된 버킷의 경우)

    • 객체에 대해 수행되는 작업에 대한 정합성 제어를 설정합니다

    • 버킷의 CORS 구성을 생성, 업데이트 및 삭제합니다

    • 객체에 대한 마지막 액세스 시간 업데이트를 설정 및 해제합니다

    • CloudMirror 복제, 알림 및 검색 통합(메타데이터 알림)을 비롯한 플랫폼 서비스에 대한 구성 설정 관리

    • 빈 버킷을 삭제합니다

  • Swift *: 컨테이너에 사용되는 정합성 수준을 설정합니다

  • * deactivated - features * — 비활성화된 기능을 보기 위한 작업.

  • * 끝점 * — 끝점을 관리하는 작업. 엔드포인트는 S3 버킷이 StorageGRID CloudMirror 복제, 알림 또는 검색 통합에 외부 서비스를 사용할 수 있도록 합니다.

  • * 그룹 * — 로컬 테넌트 그룹을 관리하고 외부 ID 소스에서 통합 테넌트 그룹을 검색하는 작업입니다.

  • * identity-source * — 외부 ID 소스를 구성하고 통합 그룹 및 사용자 정보를 수동으로 동기화하는 작업.

  • * 지역 * — StorageGRID 시스템에 대해 구성된 지역을 결정하는 작업.

  • * S3 * — 테넌트 사용자를 위한 S3 액세스 키를 관리하는 운영

  • * S3-오브젝트 잠금 * — 글로벌 S3 오브젝트 잠금 설정에서 운영, 규정 준수 지원에 사용됩니다.

  • * 사용자 * — 테넌트 사용자를 보고 관리하는 작업.

작업 세부 정보

각 API 작업을 확장하면 HTTP 동작, 끝점 URL, 필수 또는 선택적 매개 변수 목록, 요청 본문(필요한 경우) 예제 및 가능한 응답을 볼 수 있습니다.

Swagger API에서 그룹 가져오기 작업을 보여 주는 예

API 요청을 발행합니다

중요 API Docs 웹 페이지를 사용하여 수행하는 모든 API 작업은 라이브 작업입니다. 실수로 구성 데이터나 기타 데이터를 작성, 업데이트 또는 삭제하지 않도록 주의하십시오.
단계
  1. 요청 세부 정보를 보려면 HTTP 작업을 선택합니다.

  2. 요청에 그룹 또는 사용자 ID와 같은 추가 매개 변수가 필요한지 확인합니다. 그런 다음 이 값을 구합니다. 필요한 정보를 얻기 위해 먼저 다른 API 요청을 발급해야 할 수도 있습니다.

  3. 예제 요청 본문을 수정해야 하는지 확인합니다. 이 경우 * Model * 을 선택하여 각 필드의 요구 사항을 확인할 수 있습니다.

  4. 체험하기 * 를 선택합니다.

  5. 필요한 매개 변수를 제공하거나 요청 본문을 필요에 따라 수정합니다.

  6. Execute * 를 선택합니다.

  7. 응답 코드를 검토하여 요청이 성공했는지 확인합니다.