Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Queue Service 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
Queue Service
- 1: CLIs
- 1.1: Check Queue Name Duplication
- 1.1.1: 1.0
- 1.2: Create Queue
- 1.2.1: 1.0
- 1.3: Delete Acl
- 1.3.1: 1.0
- 1.4: Delete Queue
- 1.4.1: 1.0
- 1.5: List Queue
- 1.5.1: 1.0
- 1.6: Set Acl
- 1.6.1: 1.0
- 1.7: Show Queue
- 1.7.1: 1.0
- 1.8: Update Queue Config
- 1.8.1: 1.0
- 1.9: Update Queue Description
- 1.9.1: 1.0
1 - CLIs
1.1 - Check Queue Name Duplication
1.1.1 - 1.0
scpcli queueservice check queue name duplication
--name <value>
Description
Queue명 중복 체크
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Queue명 | test-queue.fifo |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
1.2 - Create Queue
1.2.1 - 1.0
scpcli queueservice queue create
--id <value>
--name <value>
--message_size <value>
--message_retention_period_unit <value>
--message_retention_period <value>
[--data_key_reuse_period <value>]
[--data_key_reuse_period_unit <value>]
[--description <value>]
[--tags <value>]
Description
Queue 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | KMS ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| name required | string | KMS명 | test-kms |
| message_size required | integer | 메시지 크기 | 256 |
| message_retention_period_unit required | string | 기간 단위 | minute |
| message_retention_period required | integer | 메시지 보존 기간 | 40 |
| data_key_reuse_period optional | integer | 데이터 키 재사용 기간 | 40 |
| data_key_reuse_period_unit optional | **** | 기간 단위 | minute |
| description optional | string | 설명 | Queue description |
| tags optional | array | 태그 목록 | '{"key": "key1", "value": "value1"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| messages | 설명 | Create Queue |
| state | Queue 상태 | ACTIVE |
1.3 - Delete Acl
1.3.1 - 1.0
scpcli queueservice queue delete acl
--queue_id <value>
--ip_address <value>
Description
접근 허용 IP 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| ip_address required | array | 접근 허용 IP 목록 | 0.0.0.0 |
1.4 - Delete Queue
1.4.1 - 1.0
scpcli queueservice queue delete
--queue_id <value>
Description
Queue 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
1.5 - List Queue
1.5.1 - 1.0
scpcli queueservice queue list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
Queue 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Queue명 | test-queue.fifo |
Responses
| Name | Description | Example |
|---|---|---|
| id | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| account_id | Account ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| encryption | 암호화 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Queue명 | test-queue.fifo |
| number_wait_messages | 대기 메시지 수 | 10 |
| state | Queue 상태 | ACTIVE |
| type | Queue 유형 | FIFO |
1.6 - Set Acl
1.6.1 - 1.0
scpcli queueservice queue set acl
--queue_id <value>
--ip_address <value>
Description
접근 허용 IP 추가
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| ip_address required | array | 접근 허용 IP 목록 | 0.0.0.0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
1.7 - Show Queue
1.7.1 - 1.0
scpcli queueservice queue show
--queue_id <value>
Description
Queue 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| ip_address | IP 주소 | 192.168.0.0 |
1.8 - Update Queue Config
1.8.1 - 1.0
scpcli queueservice queue set config
--queue_id <value>
--name <value>
--id <value>
--message_size <value>
--message_retention_period_unit <value>
--message_retention_period <value>
[--data_key_reuse_period <value>]
[--data_key_reuse_period_unit <value>]
Description
Queue 구성 설정 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| name required | string | KMS명 | test-kms |
| id required | string | KMS ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| message_size required | integer | 메시지 크기 | 256 |
| message_retention_period_unit required | string | 기간 단위 | minute |
| message_retention_period required | integer | 메시지 보존 기간 | 40 |
| data_key_reuse_period optional | integer | 데이터 키 재사용 기간 | 40 |
| data_key_reuse_period_unit optional | **** | 기간 단위 | minute |