1 - Check Queue Name Duplication

1.1 - 1.1

scpcli queueservice check queue name duplication
--name <value>

Description

Queue명 중복 체크

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringQueue명test-queue.fifo

Responses

NameDescriptionExample
result결과True

1.2 - 1.0

scpcli queueservice check queue name duplication
--name <value>

Description

Queue명 중복 체크

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260919

Parameters

NameTypeDescriptionExample
name
required
stringQueue명test-queue.fifo

Responses

NameDescriptionExample
result결과True

2 - Create Queue

2.1 - 1.1

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.1-

Parameters

NameTypeDescriptionExample
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS명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

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
messages설명Create Queue
stateQueue 상태ACTIVE

2.2 - 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 (SUPPORTED)

버전최소 지원 보장일
1.020260919

Parameters

NameTypeDescriptionExample
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS명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

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
messages설명Create Queue
stateQueue 상태ACTIVE

3 - Delete Acl

3.1 - 1.1

scpcli queueservice queue delete acl
--queue_id <value>
--ip_address <value>

Description

접근 허용 IP 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
array접근 허용 IP 목록192.168.0.0

3.2 - 1.0

scpcli queueservice queue delete acl
--queue_id <value>
--ip_address <value>

Description

접근 허용 IP 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
array접근 허용 IP 목록192.168.0.0

4 - Delete Queue

4.1 - 1.1

scpcli queueservice queue delete
--queue_id <value>

Description

Queue 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

4.2 - 1.0

scpcli queueservice queue delete
--queue_id <value>

Description

Queue 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

5 - Get Queue Attributes

5.1 - 1.1

scpcli queueservice queue get attributes
--queue_id <value>
--name <value>
--attributes <value>

Description

Queue 속성 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringQueue명test-queue.fifo
attributes
required
stringQueue 속성All

Responses

NameDescriptionExample
attributes
queue_urlQueue URLhttps://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue

6 - List Queue

6.1 - 1.1

scpcli queueservice queue list

Description

Queue 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
count합계20
queue_urlsQueue URL 목록[‘https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue’, ‘https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2’]

6.2 - 1.0

scpcli queueservice queue list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Queue 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260919

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringQueue명test-queue.fifo

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID8c9f6c1c928a45b4bbd1e4da5531d656
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
encryption암호화
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameQueue명test-queue.fifo
number_wait_messages대기 메시지 수10
stateQueue 상태ACTIVE
typeQueue 유형FIFO

7 - Set Acl

7.1 - 1.1

scpcli queueservice queue set acl
--queue_id <value>
--ip_address <value>

Description

접근 허용 IP 추가

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
array접근 허용 IP 목록192.168.0.0

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

7.2 - 1.0

scpcli queueservice queue set acl
--queue_id <value>
--ip_address <value>

Description

접근 허용 IP 추가

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
array접근 허용 IP 목록192.168.0.0

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

8 - Show Queue

8.1 - 1.1

scpcli queueservice queue show
--queue_id <value>

Description

Queue 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
ip_addressIP 주소192.168.0.0/32

8.2 - 1.0

scpcli queueservice queue show
--queue_id <value>

Description

Queue 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
ip_addressIP 주소192.168.0.0/32

9 - Update Queue Config

9.1 - 1.1

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.1-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS명test-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
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

9.2 - 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 (SUPPORTED)

버전최소 지원 보장일
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS명test-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
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

10 - Update Queue Description

10.1 - 1.1

scpcli queueservice queue set description
--queue_id <value>
--description <value>

Description

Queue 설명 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
description
required
string설명Queue description

10.2 - 1.0

scpcli queueservice queue set description
--queue_id <value>
--description <value>

Description

Queue 설명 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
description
required
string설명Queue description