Classic/VPC 환경에서 이용 가능합니다.
Ncloud Storage는 인터넷 상에 데이터를 저장하고 관리할 수 있는 네이버 클라우드 플랫폼의 오브젝트 스토리지 서비스입니다. Ncloud Storage에서는 버킷과 객체 관리 기능에 대한 CLI를 Amazon S3 CLI와 호환되는 aws 명령어로 제공합니다.
Ncloud Storage 공통 설정
Ncloud Storage CLI를 사용하기 위한 설치와 인증 방법, 공통으로 사용하는 명령어와 옵션 형식을 설명합니다.
설치
Ncloud Storage CLI는 AWS CLI를 설치하여 사용합니다. 설치 명령어는 다음과 같습니다.
pip3 install awscli
pip3 명령어로는 AWS CLI v1이 설치되며, 이 가이드의 예시는 v1 출력을 기준으로 작성되었습니다. AWS CLI v2 설치 방법은 AWS CLI 설치 가이드를 참조해 주십시오.
인증
인증 정보를 설정하는 명령어는 다음과 같습니다.
aws configure
명령을 실행한 후 다음 항목을 차례대로 입력해 주십시오.
AWS Access Key ID [None]: {access_key_id}
AWS Secret Access Key [None]: {secret_key}
Default region name [None]: kr
Default output format [None]: [Enter]
access_key_id와secret_key를 확인하는 방법은 API 인증키를 참조해 주십시오.- Ncloud Storage는 현재 KR 리전만 지원합니다.
- 지원하는 출력 형식은
json,text,table,yaml,yaml-stream입니다.
구문
aws는 다음 구문으로 실행합니다.
aws s3 <subcommand> [options] --endpoint-url <endpoint-url>
aws s3api <subcommand> [options] --endpoint-url <endpoint-url>
- CLI 이용 시
--endpoint-url옵션을 반드시 입력해야 합니다. 리전별 호출 도메인은 다음과 같습니다.- 리전: 한국
- 리전 이름: kr
- 호출 도메인: https://kr.ncloudstorage.com
- 제공 리전은 지속적으로 확대할 예정입니다.
s3는 Ncloud Storage를 파일 시스템처럼 다루는 High-level 명령어이고, s3api는 Ncloud Storage API와 1:1로 대응하는 API-level 명령어입니다.
도움말을 확인하는 명령어는 다음과 같습니다.
aws help
aws <command> help
aws <command> <subcommand> help
옵션
aws에서 공통으로 사용할 수 있는 옵션입니다.
| 옵션 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
--endpoint-url |
String | Required | 명령을 호출할 엔드포인트 URL
|
--region |
String | Optional | 리전
|
--profile |
String | Optional | 자격 증명 파일과 설정 파일에서 사용할 프로필 이름
|
--no-sign-request |
Boolean | Optional | 요청 서명 비활성화
|
--cli-input-json, --cli-input-yaml |
String | Optional | JSON 또는 YAML 형식으로 명령의 파라미터 입력
|
--generate-cli-skeleton |
String | Optional | 명령을 실행하지 않고 파라미터 템플릿 생성
|
--cli-auto-prompt |
Boolean | Optional | 옵션 자동 프롬프트 활성화
|
--no-cli-auto-prompt |
Boolean | Optional | 옵션 자동 프롬프트 비활성화 |
--output |
String | Optional | 응답 결과의 형식
|
--query |
String | Optional | 응답 결과 필터링 시 사용할 JMESPath 쿼리 |
--color |
String | Optional | 출력 색상 사용 여부
|
--no-paginate |
Boolean | Optional | 자동 페이지네이션 비활성화
|
--no-cli-pager |
Boolean | Optional | CLI 페이저 비활성화
|
--ca-bundle |
String | Optional | SSL 인증서를 검증할 때 사용할 CA 인증서 번들 경로 |
--no-verify-ssl |
Boolean | Optional | SSL 인증서 검증 비활성화 |
--cli-connect-timeout |
Integer | Optional | 최대 연결 시간 (초)
|
--cli-read-timeout |
Integer | Optional | 최대 읽기 시간 (초)
|
--debug |
Boolean | Optional | 디버그 로깅 활성화 |
Ncloud Storage 명령어
aws 명령어에서 실행할 수 있는 하위 명령어 목록입니다.
High-level
High-level 명령어를 사용하면 Ncloud Storage를 파일 시스템처럼 접근하고 관리할 수 있습니다. 관련 명령어는 다음과 같습니다.
| 명령어 | 설명 |
|---|---|
| mb | 버킷 생성 |
| ls | 버킷 및 객체 조회 |
| cp | 객체 복사 |
| mv | 객체 이동 |
| sync | 객체 동기화 |
| presign | 객체 사전 서명(Pre-signed) URL 생성 |
| rm | 객체 삭제 |
| rb | 버킷 삭제 |
API-level
API-level 명령어는 Ncloud Storage API와 1:1로 대응합니다. 관련 명령어는 다음과 같습니다.
| 명령어 | 설명 |
|---|---|
| create-bucket | Ncloud Storage에 객체를 저장할 버킷 생성 |
| list-buckets | 사용자가 소유한 모든 버킷의 목록 조회 |
| head-bucket | Ncloud Storage에 생성한 버킷의 속성 조회 |
| get-bucket-location | Ncloud Storage에 생성한 버킷의 리전 정보 조회 |
| delete-bucket | Ncloud Storage에 생성한 버킷 삭제 |
| get-bucket-versioning | 버킷의 버전 관리 설정 여부 조회 |
| put-bucket-versioning | 버킷의 버전 관리 설정 |
| get-bucket-encryption | 버킷에 설정된 암호화 방식 조회 |
| put-bucket-encryption | 버킷에 기본 서버측 암호화(SSE) 설정 |
| delete-bucket-encryption | 버킷에 설정된 암호화 설정 삭제 |
| get-bucket-cors | 버킷에 설정된 CORS 규칙 조회 |
| put-bucket-cors | 버킷에 CORS 규칙 설정 |
| delete-bucket-cors | 버킷에 설정된 CORS 규칙 삭제 |
| get-bucket-lifecycle-configuration | 버킷에 등록한 수명주기 규칙 조회 |
| put-bucket-lifecycle-configuration | 버킷에 수명주기 규칙 등록 |
| delete-bucket-lifecycle | 버킷에 등록한 수명주기 규칙 삭제 |
| get-object-lock-configuration | 버킷에 설정된 Object Lock 설정 조회 |
| put-object-lock-configuration | 버킷에 Object Lock 설정 적용 |
| put-object | Ncloud Storage에 객체 저장 |
| get-object | Ncloud Storage에 생성한 객체 다운로드 |
| head-object | Ncloud Storage에 저장한 객체의 메타데이터 조회 |
| copy-object | Ncloud Storage에 저장한 객체 복사 |
| get-object-attributes | Ncloud Storage에 저장한 객체의 속성 조회 |
| list-objects | 버킷에 저장된 객체의 리스트 조회 |
| list-objects-v2 | 버킷에 저장된 객체의 리스트 조회 |
| list-object-versions | 버전 관리를 사용하는 버킷에 저장한 객체의 모든 버전 메타데이터 조회 |
| delete-object | Ncloud Storage에 저장한 객체 삭제 |
| delete-objects | Ncloud Storage에 저장한 여러 개의 객체를 동시에 삭제 |
| restore-object | Deep Archive Class에 저장한 객체 복원 |
| get-object-legal-hold | 객체에 설정된 법적 보존(Legal Hold) 상태 조회 |
| put-object-legal-hold | 객체에 법적 보존(Legal Hold) 설정 |
| get-object-retention | 객체에 설정된 보존(Retention) 정보 조회 |
| put-object-retention | 객체에 보존(Retention) 설정 |
| create-multipart-upload | 멀티파트 업로드를 시작하고 업로드 ID 반환 |
| upload-part | 멀티파트 업로드의 파트 업로드 |
| upload-part-copy | Ncloud Storage에 저장된 대용량의 객체 복사 |
| list-parts | 특정 멀티파트 업로드를 통해 업로드된 파트의 리스트 조회 |
| list-multipart-uploads | 현재 진행 중인 멀티파트 업로드의 리스트 조회 |
| complete-multipart-upload | 업로드한 파트를 조합하여 객체를 생성하고 멀티파트 업로드 완료 |
| abort-multipart-upload | 진행 중인 멀티파트 업로드 중지 |
Ncloud Storage 연관 리소스
Ncloud Storage CLI에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.
- Ncloud Storage CLI 서비스 사용 방법
- Ncloud Storage 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 Ncloud Storage 사용하는 방법
- Ncloud Storage API 가이드: Ncloud Storage API를 호출하는 방법
- Ncloud Storage 사용 환경 가이드: VPC, Classic 환경 및 지원 여부에 관한 사용 가이드
- 요금 소개, 특징, 상세 기능: Ncloud Storage의 요금 체계, 특징, 상세 기능 요약
- 서비스 최신 소식: Ncloud Storage 관련 최신 소식
- 자주 하는 질문: Ncloud Storage 사용자들이 자주 하는 질문
- 고객 지원: CLI 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의