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

Return to the regular view of this page.

CLIs

1: Check Queue Name Duplication

1.1: 1.2
1.2: 1.1
1.3: 1.0

2: Create Queue

2.1: 1.2
2.2: 1.1
2.3: 1.0

3: Delete Acl

3.1: 1.2
3.2: 1.1
3.3: 1.0

4: Delete Queue

4.1: 1.2
4.2: 1.1
4.3: 1.0

5: Get Queue Attributes

5.1: 1.2
5.2: 1.1

6: List Queue

6.1: 1.2
6.2: 1.1
6.3: 1.0

7: Set Acl

7.1: 1.2
7.2: 1.1
7.3: 1.0

8: Show Queue

8.1: 1.2
8.2: 1.1
8.3: 1.0

9: Update Queue Config

9.1: 1.2
9.2: 1.1
9.3: 1.0

10: Update Queue Deduplication

10.1: 1.2

11: Update Queue Deduplication Scope

11.1: 1.2

12: Update Queue Description

12.1: 1.2
12.2: 1.1
12.3: 1.0

1 - Check Queue Name Duplication

1.1 - 1.2

scp-cli queueservice check queue name duplication
--name <value>

Description

check queue name duplication

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

Name	Description	Example
result	Result	True

1.2 - 1.1

scp-cli queueservice check queue name duplication
--name <value>

Description

check queue name duplication

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

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

Responses

Name	Description	Example
result	Result	True

1.3 - 1.0

scp-cli 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

2 - Create Queue

2.1 - 1.2

scp-cli queueservice queue create
--encryption_name <value>
--name <value>
--id <value>
--message_size <value>
--message_retention_period_unit <value>
--message_retention_period <value>
[--content_based_deduplication <value>]
[--data_key_reuse_period <value>]
[--data_key_reuse_period_unit <value>]
[--deduplication_scope <value>]
[--description <value>]
[--tags <value>]

Description

create a queue

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
encryption_name required	string	KMS name	`test-kms`
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`
content_based_deduplication optional	boolean	Content based deduplication	`False`
data_key_reuse_period optional	integer	Data key reuse period	`40`
data_key_reuse_period_unit optional	****	Period unit	`minute`
deduplication_scope optional	****	Deduplication scope	`Queue`
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

2.2 - 1.1

scp-cli queueservice queue create
--encryption_name <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 <value>]
[--tags <value>]

Description

create a queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Name	Type	Description	Example
encryption_name required	string	KMS name	`test-kms`
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`
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

2.3 - 1.0

scp-cli queueservice queue create
--encryption_name <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 <value>]
[--tags <value>]

Description

create a queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Name	Type	Description	Example
encryption_name required	string	KMS name	`test-kms`
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`
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

3 - Delete Acl

3.1 - 1.2

scp-cli queueservice queue delete acl
--queue_id <value>
--ip_address <value>

Description

delete an acl policy

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

3.2 - 1.1

scp-cli queueservice queue delete acl
--queue_id <value>
--ip_address <value>

Description

delete an acl policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

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

3.3 - 1.0

scp-cli 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`

4 - Delete Queue

4.1 - 1.2

scp-cli queueservice queue delete
--queue_id <value>

Description

delete a specific queue

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

4.2 - 1.1

scp-cli queueservice queue delete
--queue_id <value>

Description

delete a specific queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

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

4.3 - 1.0

scp-cli 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`

5 - Get Queue Attributes

5.1 - 1.2

scp-cli queueservice queue get attributes
--queue_id <value>
--name <value>
--attributes <value>

Description

get queue attributes

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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

5.2 - 1.1

scp-cli queueservice queue get attributes
--queue_id <value>
--name <value>
--attributes <value>

Description

get queue attributes

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

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

6 - List Queue

6.1 - 1.2

scp-cli queueservice queue list

Description

list queue

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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’]

6.2 - 1.1

scp-cli queueservice queue list

Description

list queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

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’]

6.3 - 1.0

scp-cli 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

7 - Set Acl

7.1 - 1.2

scp-cli queueservice queue set acl
--queue_id <value>
--ip_address <value>

Description

update an acl policy

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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

7.2 - 1.1

scp-cli queueservice queue set acl
--queue_id <value>
--ip_address <value>

Description

update an acl policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

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

7.3 - 1.0

scp-cli 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

8 - Show Queue

8.1 - 1.2

scp-cli queueservice queue show
--queue_id <value>

Description

show a specific queue

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	8c9f6c1c928a45b4bbd1e4da5531d656
allow_ip_access	Access Allowed IP List	[‘192.168.0.0’, ‘172.16.0.0/12’]
content_based_deduplication	Content based deduplication	False
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
data_key_reuse_period	Data key reuse period	40
data_key_reuse_period_unit	Period unit	minute
deduplication_scope	Deduplication scope	Queue
description	Description	Queue description
encryption	Encryption	{}
message_retention_period	Message retention period	40
message_retention_period_unit	Period unit	minute
message_size	Message size	256
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
privatelink_service_id	Privatelink Service ID	8c9f6c1c928a45b4bbd1e4da5531d656
state	Queue state	ACTIVE
type	Queue Type	FIFO

8.2 - 1.1

scp-cli queueservice queue show
--queue_id <value>

Description

show a specific queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

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

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	8c9f6c1c928a45b4bbd1e4da5531d656
allow_ip_access	Access Allowed IP List	[‘192.168.0.0’, ‘172.16.0.0/12’]
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
data_key_reuse_period	Data key reuse period	40
data_key_reuse_period_unit	Period unit	minute
description	Description	Queue description
encryption	Encryption	{}
message_retention_period	Message retention period	40
message_retention_period_unit	Period unit	minute
message_size	Message size	256
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
privatelink_service_id	Privatelink Service ID	8c9f6c1c928a45b4bbd1e4da5531d656
state	Queue state	ACTIVE
type	Queue Type	FIFO

8.3 - 1.0

scp-cli 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
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	8c9f6c1c928a45b4bbd1e4da5531d656
allow_ip_access	Access Allowed IP List	[‘192.168.0.0’, ‘172.16.0.0/12’]
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
data_key_reuse_period	Data key reuse period	40
data_key_reuse_period_unit	Period unit	minute
description	Description	Queue description
encryption	Encryption	{}
message_retention_period	Message retention period	40
message_retention_period_unit	Period unit	minute
message_size	Message size	256
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

9 - Update Queue Config

9.1 - 1.2

scp-cli 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.2	-

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`

9.2 - 1.1

scp-cli 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.1	20270220

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`

9.3 - 1.0

scp-cli 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`

10 - Update Queue Deduplication

10.1 - 1.2

scp-cli queueservice queue set deduplication
--queue_id <value>
--content_based_deduplication <value>

Description

update queue deduplication

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
content_based_deduplication required	boolean	Content based deduplication	`False`

11 - Update Queue Deduplication Scope

11.1 - 1.2

scp-cli queueservice queue set deduplication scope
--queue_id <value>
--deduplication_scope <value>

Description

update queue deduplication scope

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

12 - Update Queue Description

12.1 - 1.2

scp-cli queueservice queue set description
--queue_id <value>
--description <value>

Description

update queue description

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

12.2 - 1.1

scp-cli queueservice queue set description
--queue_id <value>
--description <value>

Description

update queue description

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

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

12.3 - 1.0

scp-cli 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`