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

StorageGRID 테넌트 관리 API에 대해 알아보십시오

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

테넌트 관리 API:

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

  • "중단 없는 업그레이드를 지원하는 버전 관리"을(를) 사용합니다.

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

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

  2. 테넌트 관리자 상단에서 도움말 아이콘을 선택한 다음 *API 문서*를 선택합니다.

API 작업

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

  • 계정: 현재 테넌트 계정에 대한 작업(저장 공간 사용량 정보 가져오기 포함).

  • auth: 사용자 세션 인증을 수행하는 작업입니다.

    테넌트 관리 API는 베어러 토큰 인증 방식을 지원합니다. 테넌트 로그인을 위해 인증 요청의 JSON 본문에 사용자 이름, 비밀번호 및 accountId를 제공해야 합니다(즉, POST /api/v3/authorize). 사용자가 인증에 성공하면 보안 토큰이 반환됩니다. 이 토큰은 이후 API 요청의 헤더에 포함해야 합니다("Authorization: Bearer token").

    인증 보안 개선에 대한 자세한 내용은 "사이트 간 요청 위조(CSRF) 공격으로부터 보호"을 참조하십시오.

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

  • 컨테이너: S3 버킷에 대한 작업.

  • deactivated-features: 비활성화되었을 수 있는 기능을 확인하기 위한 작업입니다.

  • 엔드포인트: 엔드포인트를 관리하는 작업입니다. 엔드포인트를 통해 S3 버킷은 StorageGRID CloudMirror 복제, 알림 또는 검색 통합을 위해 외부 서비스를 사용할 수 있습니다.

  • grid-federation-connections: 그리드 페더레이션 연결 및 그리드 간 복제에 대한 작업입니다.

  • groups: 로컬 테넌트 그룹을 관리하고 외부 ID 소스에서 페더레이션된 테넌트 그룹을 검색하는 작업입니다.

  • identity-source: 외부 ID 소스를 구성하고 페더레이션된 그룹 및 사용자 정보를 수동으로 동기화하는 작업입니다.

  • ilm: 정보 라이프사이클 관리(ILM) 설정에 대한 작업.

  • regions: StorageGRID 시스템에 대해 구성된 지역을 확인하는 작업입니다.

  • s3: 테넌트 사용자를 위한 S3 액세스 키 관리 작업입니다.

  • s3-object-lock: 규정 준수를 지원하기 위해 사용되는 전역 S3 Object Lock 설정에 대한 작업입니다.

  • 사용자: 테넌트 사용자를 보고 관리하는 작업입니다.

작업 세부 정보

각 API 작업을 펼쳐보면 HTTP 작업, 엔드포인트 URL, 필수 또는 선택적 매개변수 목록, 요청 본문 예시(필요한 경우) 및 가능한 응답을 확인할 수 있습니다.

Swagger API에서 GET 그룹 작업을 보여주는 예시

API 요청 발행

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

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

  3. 예제 요청 본문을 수정해야 하는지 판단하세요. 수정해야 하는 경우, *모델*을 선택하여 각 필드에 대한 요구 사항을 확인할 수 있습니다.

  4. *직접 사용해보기*를 선택합니다.

  5. 필요한 매개변수를 제공하거나 필요에 따라 요청 본문을 수정하십시오.

  6. *실행*을 선택합니다.

  7. 요청이 성공했는지 여부를 확인하려면 응답 코드를 검토하십시오.