This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Queue Service

1: CLIs

1.1: Check Queue Name Duplication

1.1.1: 1.1
1.1.2: 1.0

1.2: Create Queue

1.2.1: 1.1
1.2.2: 1.0

1.3: Delete Acl

1.3.1: 1.1
1.3.2: 1.0

1.4: Delete Queue

1.4.1: 1.1
1.4.2: 1.0

1.5: Get Queue Attributes

1.5.1: 1.1

1.6: List Queue

1.6.1: 1.1
1.6.2: 1.0

1.7: Set Acl

1.7.1: 1.1
1.7.2: 1.0

1.8: Show Queue

1.8.1: 1.1
1.8.2: 1.0

1.9: Update Queue Config

1.9.1: 1.1
1.9.2: 1.0

1.10: Update Queue Description

1.10.1: 1.1
1.10.2: 1.0

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Queue Service service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before
1.1	CURRENT	-
1.0	SUPPORTED	20260919

1 - CLIs

1.1 - Check Queue Name Duplication

1.1.1 - 1.1

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

Description

check queue name duplication

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Queue name	`test-queue.fifo`

Responses

Name	Description	Example
result	Result	True

1.1.2 - 1.0

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

Description

check queue name duplication

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Name	Type	Description	Example
name required	string	Queue name	`test-queue.fifo`

Responses

Name	Description	Example
result	Result	True

1.2 - Create Queue

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

create a queue

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
id required	string	KMS ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
name required	string	KMS name	`test-kms`
message_size required	integer	Message size	`256`
message_retention_period_unit required	string	Period unit	`minute`
message_retention_period required	integer	Message retention period	`40`
data_key_reuse_period optional	integer	Data key reuse period	`40`
data_key_reuse_period_unit optional	****	Period unit	`minute`
description optional	string	Description	`Queue description`
tags optional	array	Tag List	`'{"key": "key1", "value": "value1"}'`

Responses

Name	Description	Example
id	Queue ID	8c9f6c1c928a45b4bbd1e4da5531d656
messages	Description	Create Queue
state	Queue state	ACTIVE

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

create a queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Name	Type	Description	Example
id required	string	KMS ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
name required	string	KMS name	`test-kms`
message_size required	integer	Message size	`256`
message_retention_period_unit required	string	Period unit	`minute`
message_retention_period required	integer	Message retention period	`40`
data_key_reuse_period optional	integer	Data key reuse period	`40`
data_key_reuse_period_unit optional	****	Period unit	`minute`
description optional	string	Description	`Queue description`
tags optional	array	Tag List	`'{"key": "key1", "value": "value1"}'`

Responses

Name	Description	Example
id	Queue ID	8c9f6c1c928a45b4bbd1e4da5531d656
messages	Description	Create Queue
state	Queue state	ACTIVE

1.3 - Delete Acl

1.3.1 - 1.1

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

Description

delete an acl policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
ip_address required	array	Access Allowed IP List	`192.168.0.0`

1.3.2 - 1.0

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

Description

delete an acl policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
ip_address required	array	Access Allowed IP List	`192.168.0.0`

1.4 - Delete Queue

1.4.1 - 1.1

scpcli queueservice queue delete
--queue_id <value>

Description

delete a specific queue

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

1.4.2 - 1.0

scpcli queueservice queue delete
--queue_id <value>

Description

delete a specific queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

1.5 - Get Queue Attributes

1.5.1 - 1.1

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

Description

get queue attributes

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
name required	string	Queue name	`test-queue.fifo`
attributes required	string	Queue Attributes	`All`

Responses

Name	Description	Example
attributes
queue_url	Queue URL	https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue

1.6 - List Queue

1.6.1 - 1.1

scpcli queueservice queue list

Description

list queue

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Responses

Name	Description	Example
count	Count	20
queue_urls	Queue URL List	[‘https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue’, ‘https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2’]

1.6.2 - 1.0

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

Description

list queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

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 name	`test-queue.fifo`

Responses

Name	Description	Example
id	Queue ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	8c9f6c1c928a45b4bbd1e4da5531d656
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
encryption	Encryption
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Queue name	test-queue.fifo
number_wait_messages	Number of waiting messages	10
state	Queue state	ACTIVE
type	Queue Type	FIFO

1.7 - Set Acl

1.7.1 - 1.1

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

Description

update an acl policy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
ip_address required	array	Access Allowed IP List	`192.168.0.0`

Responses

Name	Description	Example
id	Queue ID	8c9f6c1c928a45b4bbd1e4da5531d656

1.7.2 - 1.0

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

Description

update an acl policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
ip_address required	array	Access Allowed IP List	`192.168.0.0`

Responses

Name	Description	Example
id	Queue ID	8c9f6c1c928a45b4bbd1e4da5531d656

1.8 - Show Queue

1.8.1 - 1.1

scpcli queueservice queue show
--queue_id <value>

Description

show a specific queue

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
ip_address	IP address	192.168.0.0/32

1.8.2 - 1.0

scpcli queueservice queue show
--queue_id <value>

Description

show a specific queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
ip_address	IP address	192.168.0.0/32

1.9 - Update Queue Config

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

update queue config

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
name required	string	KMS name	`test-kms`
id required	string	KMS ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
message_size required	integer	Message size	`256`
message_retention_period_unit required	string	Period unit	`minute`
message_retention_period required	integer	Message retention period	`40`
data_key_reuse_period optional	integer	Data key reuse period	`40`
data_key_reuse_period_unit optional	****	Period unit	`minute`

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

update queue config

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
name required	string	KMS name	`test-kms`
id required	string	KMS ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
message_size required	integer	Message size	`256`
message_retention_period_unit required	string	Period unit	`minute`
message_retention_period required	integer	Message retention period	`40`
data_key_reuse_period optional	integer	Data key reuse period	`40`
data_key_reuse_period_unit optional	****	Period unit	`minute`

1.10 - Update Queue Description

1.10.1 - 1.1

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

Description

update queue description

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
description required	string	Description	`Queue description`

1.10.2 - 1.0

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

Description

update queue description

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
description required	string	Description	`Queue description`