A.17. Ceph 오브젝트 게이트웨이

Ceph RESTful API rgw 엔드포인트를 사용하여 Ceph Object Gateway를 관리하는 방법 참조입니다.

GET /api/rgw/status
설명
Ceph Object Gateway 상태를 표시합니다.
예제
GET /api/rgw/status HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
GET /api/rgw/daemon
설명
Ceph Object Gateway 데몬을 표시합니다.
예제
GET /api/rgw/daemon HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
GET /api/rgw/daemon/SVC_ID
매개 변수
  • SVC_ID 를 문자열 값으로 서비스 식별자로 바꿉니다.
예제
GET /api/rgw/daemon/SVC_ID HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
GET /api/rgw/site
매개 변수
  • 쿼리:

    • 쿼리 - 문자열 값입니다.
    • daemon_name - 문자열 값으로 데몬의 이름입니다.
예제
GET /api/rgw/site HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.

bucket Management

GET /api/rgw/bucket
매개 변수
  • 쿼리:

    • 통계 - 버킷 통계의 부울 값입니다.
    • daemon_name - 문자열 값으로 데몬의 이름입니다.
예제
GET /api/rgw/bucket HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
POST /api/rgw/bucket
예제
POST /api/rgw/bucket HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket": "STRING",
    "daemon_name": "STRING",
    "lock_enabled": "false",
    "lock_mode": "STRING",
    "lock_retention_period_days": "STRING",
    "lock_retention_period_years": "STRING",
    "placement_target": "STRING",
    "uid": "STRING",
    "zonegroup": "STRING"
}
상태 코드
  • 201 생성 - 리소스가 생성되었습니다.
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
DELETE /api/rgw/bucket/BUCKET
매개 변수
  • BUCKET 을 문자열 값으로 버킷 이름으로 교체합니다.
  • 쿼리:

    • purge_objects - 문자열 값입니다.
    • daemon_name - 문자열 값으로 데몬의 이름입니다.
상태 코드
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 204 콘텐츠 없음 - 리소스가 삭제되었습니다.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
GET /api/rgw/bucket/BUCKET
매개 변수
  • BUCKET 을 문자열 값으로 버킷 이름으로 교체합니다.
  • 쿼리:

    • daemon_name - 문자열 값으로 데몬의 이름입니다.
예제
GET /api/rgw/bucket/BUCKET HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
PUT /api/rgw/bucket/BUCKET
매개 변수
  • BUCKET 을 문자열 값으로 버킷 이름으로 교체합니다.
예제
PUT /api/rgw/bucket/BUCKET HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_id": "STRING",
    "daemon_name": "STRING",
    "lock_mode": "STRING",
    "lock_retention_period_days": "STRING",
    "lock_retention_period_years": "STRING",
    "mfa_delete": "STRING",
    "mfa_token_pin": "STRING",
    "mfa_token_serial": "STRING",
    "uid": "STRING",
    "versioning_state": "STRING"
}
상태 코드
  • 200 OK - 확인
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.

사용자 관리

GET /api/rgw/user
설명
Ceph Object Gateway 사용자를 표시합니다.
매개 변수
  • 쿼리:

    • daemon_name - 문자열 값으로 데몬의 이름입니다.
예제
GET /api/rgw/user HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
POST /api/rgw/user
예제
POST /api/rgw/user HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "STRING",
    "daemon_name": "STRING",
    "display_name": "STRING",
    "email": "STRING",
    "generate_key": "STRING",
    "max_buckets": "STRING",
    "secret_key": "STRING",
    "suspended": "STRING",
    "uid": "STRING"
}
상태 코드
  • 201 생성 - 리소스가 생성되었습니다.
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
GET /api/rgw/user/get_emails
매개 변수
  • 쿼리:

    • daemon_name - 문자열 값으로 데몬의 이름입니다.
예제
GET /api/rgw/user/get_emails HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
DELETE /api/rgw/user/UID
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
  • 쿼리:

    • daemon_name - 문자열 값으로 데몬의 이름입니다.
상태 코드
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 204 콘텐츠 없음 - 리소스가 삭제되었습니다.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
GET /api/rgw/user/UID
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
  • 쿼리:

    • daemon_name - 문자열 값으로 데몬의 이름입니다.
    • 통계 - 사용자 통계의 부울 값입니다.
예제
GET /api/rgw/user/UID HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
PUT /api/rgw/user/UID
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
예제
PUT /api/rgw/user/UID HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "STRING",
    "display_name": "STRING",
    "email": "STRING",
    "max_buckets": "STRING",
    "suspended": "STRING"
}
상태 코드
  • 200 OK - 확인
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
DELETE /api/rgw/user/UID/capability
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
  • 쿼리:

    • daemon_name - 문자열 값으로 데몬의 이름입니다.
    • 유형 - 필수 항목입니다. 문자열 값입니다.
    • perm - 필수 항목입니다. 문자열 값입니다.
상태 코드
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 204 콘텐츠 없음 - 리소스가 삭제되었습니다.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
POST /api/rgw/user/UID/capability
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
예제
POST /api/rgw/user/UID/capability HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "STRING",
    "perm": "STRING",
    "type": "STRING"
}
상태 코드
  • 201 생성 - 리소스가 생성되었습니다.
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
DELETE /api/rgw/user/UID/key
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
  • 쿼리:

    • daemon_name - 문자열 값으로 데몬의 이름입니다.
    • KEY_TYPE - 문자열 값입니다.
    • subuser - 문자열 값입니다.
    • access_key - 문자열 값입니다.
상태 코드
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 204 콘텐츠 없음 - 리소스가 삭제되었습니다.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
POST /api/rgw/user/UID/key
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
예제
POST /api/rgw/user/UID/key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "STRING",
    "daemon_name": "STRING",
    "generate_key": "true",
    "key_type": "s3",
    "secret_key": "STRING",
    "subuser": "STRING"
}
상태 코드
  • 201 생성 - 리소스가 생성되었습니다.
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
GET /api/rgw/user/UID/quota
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
예제
GET /api/rgw/user/UID/quota HTTP/1.1
Host: example.com
상태 코드
  • 200 OK - 확인
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
PUT /api/rgw/user/UID/quota
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
예제
PUT /api/rgw/user/UID/quota HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "STRING",
    "enabled": "STRING",
    "max_objects": "STRING",
    "max_size_kb": 1,
    "quota_type": "STRING"
}
상태 코드
  • 200 OK - 확인
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
POST /api/rgw/user/UID/subuser
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
예제
POST /api/rgw/user/UID/subuser HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access": "STRING",
    "access_key": "STRING",
    "daemon_name": "STRING",
    "generate_secret": "true",
    "key_type": "s3",
    "secret_key": "STRING",
    "subuser": "STRING"
}
상태 코드
  • 201 생성 - 리소스가 생성되었습니다.
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.
DELETE /api/rgw/user/UID/subuser/SUBUSER
매개 변수
  • UID 를 사용자 식별자로 바꿉니다.
  • SUBUSER 를 하위 사용자 이름으로 바꿉니다.
  • 쿼리:

    • purge_keys - 키를 제거하지 않도록 false 로 설정합니다. 이는 S3 하위 사용자에게만 적용됩니다.
    • daemon_name - 문자열 값으로 데몬의 이름입니다.
상태 코드
  • 202 허용 - 작업이 실행 중입니다. 작업 대기열을 확인하십시오.
  • 204 콘텐츠 없음 - 리소스가 삭제되었습니다.
  • 400 잘못된 요청 - 작동 예외. 자세한 내용은 응답 본문을 확인하십시오.
  • 401 승인되지 않음 - 인증되지 않은 액세스 먼저 로그인하십시오.
  • 403 forbidden - 인증되지 않은 액세스입니다. 권한을 확인해 주십시오.
  • 500 내부 서버 오류 - 예상되지 않은 오류. 스택 추적에 대한 응답 본문을 확인하십시오.

추가 리소스

  • 자세한 내용은 Red Hat Ceph Storage 개발자 가이드의 CephRESTful API 장을 참조하십시오.