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

Return to the regular view of this page.

Queue Service

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.

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20270220
1.0SUPPORTED20260919

CLI Version History

1.2

Queue Service has been updated to version 1.2.

Changes

  • [New] queueservice queue set deduplication - Update Queue Deduplication API has been changed.
  • [New] queueservice queue set deduplication - Update Queue Deduplication Scope API has been changed.
  • [Updated] queueservice queue show - Show Queue API has been changed.
  • The following fields are added to the response:
    • content_based_deduplication
    • deduplication_scope
  • [Updated] queueservice queue get attributes - Get Queue Attributes API has been changed.
  • The following fields are added to the response:
    • content_based_deduplication
    • deduplication_scope
  • [Updated] queueservice queue create - Create Queue API has been changed.
  • The following fields are added to the request:
    • content_based_deduplication
    • deduplication_scope
  • [Updated] queueservice queue set config - Update Queue Config API has been changed.
  • The following fields are added to the response:
    • content_based_deduplication
    • deduplication_scope

1.1

Queue Service has been updated to version 1.1.

Changes

  • [New] queueservice queue get attributes - Show Queue Attributes API has been added.
  • [Updated] queueservice queue list - List Queue API has been changed.
  • The following fields are added to the response:
    • queue_urls
  • [Updated] queueservice queue show - Show Queue API has been changed.
  • The following fields are added to the response:
    • privatelink_service_id
  • [Updated] queueservice queue set config - Update Queue Config API has been changed.
  • The following fields are added to the response:
    • privatelink_service_id

1.0

Queue Service version 1.0 has been released.

변경사항

  • [신규] queueservice queue list - List Queue API has been added.
  • [신규] queueservice check queue name duplication - Check Queue Name Duplication API has been added.
  • [신규] queueservice queue show - Show Queue API has been added.
  • [신규] queueservice queue create - Create Queue API has been added.
  • [신규] queueservice queue set acl - Set Acl API has been added.
  • [신규] queueservice queue set config - Update Queue Config API has been added.
  • [신규] queueservice queue set description - Update Queue Description API has been added.
  • [신규] queueservice queue delete - Delete Queue API has been added.
  • [신규] queueservice queue delete acl - Delete Acl API has been added.

1 - CLIs

1.1 - Check Queue Name Duplication

1.1.1 - 1.2

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

Description

check queue name duplication

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringQueue nametest-queue.fifo

Responses

NameDescriptionExample
resultResultTrue

1.1.2 - 1.1

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

Description

check queue name duplication

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270220

Parameters

NameTypeDescriptionExample
name
required
stringQueue nametest-queue.fifo

Responses

NameDescriptionExample
resultResultTrue

1.1.3 - 1.0

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

Description

check queue name duplication

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260919

Parameters

NameTypeDescriptionExample
name
required
stringQueue nametest-queue.fifo

Responses

NameDescriptionExample
resultResultTrue

1.2 - Create Queue

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

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
encryption_name
required
stringKMS nametest-kms
name
required
stringKMS nametest-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
message_size
required
integerMessage size256
message_retention_period_unit
required
stringPeriod unitminute
message_retention_period
required
integerMessage retention period40
content_based_deduplication
optional
booleanContent based deduplicationFalse
data_key_reuse_period
optional
integerData key reuse period40
data_key_reuse_period_unit
optional
****Period unitminute
deduplication_scope
optional
****Deduplication scopeQueue
description
optional
stringDescriptionQueue description
tags
optional
arrayTag List'{"key": "key1", "value": "value1"}'

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
messagesDescriptionCreate Queue
stateQueue stateACTIVE

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

VersionNot Before
1.120270220

Parameters

NameTypeDescriptionExample
encryption_name
required
stringKMS nametest-kms
name
required
stringKMS nametest-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
message_size
required
integerMessage size256
message_retention_period_unit
required
stringPeriod unitminute
message_retention_period
required
integerMessage retention period40
data_key_reuse_period
optional
integerData key reuse period40
data_key_reuse_period_unit
optional
****Period unitminute
description
optional
stringDescriptionQueue description
tags
optional
arrayTag List'{"key": "key1", "value": "value1"}'

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
messagesDescriptionCreate Queue
stateQueue stateACTIVE

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

VersionNot Before
1.020260919

Parameters

NameTypeDescriptionExample
encryption_name
required
stringKMS nametest-kms
name
required
stringKMS nametest-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
message_size
required
integerMessage size256
message_retention_period_unit
required
stringPeriod unitminute
message_retention_period
required
integerMessage retention period40
data_key_reuse_period
optional
integerData key reuse period40
data_key_reuse_period_unit
optional
****Period unitminute
description
optional
stringDescriptionQueue description
tags
optional
arrayTag List'{"key": "key1", "value": "value1"}'

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
messagesDescriptionCreate Queue
stateQueue stateACTIVE

1.3 - Delete Acl

1.3.1 - 1.2

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

Description

delete an acl policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
arrayAccess Allowed IP List192.168.0.0

1.3.2 - 1.1

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

Description

delete an acl policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270220

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
arrayAccess Allowed IP List192.168.0.0

1.3.3 - 1.0

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

Description

delete an acl policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
arrayAccess Allowed IP List192.168.0.0

1.4 - Delete Queue

1.4.1 - 1.2

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

Description

delete a specific queue

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

1.4.2 - 1.1

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

Description

delete a specific queue

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270220

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

1.4.3 - 1.0

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

Description

delete a specific queue

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

1.5 - Get Queue Attributes

1.5.1 - 1.2

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

Description

get queue attributes

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringQueue nametest-queue.fifo
attributes
required
stringQueue AttributesAll

Responses

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

1.5.2 - 1.1

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

Description

get queue attributes

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270220

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringQueue nametest-queue.fifo
attributes
required
stringQueue AttributesAll

Responses

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

1.6 - List Queue

1.6.1 - 1.2

scp-cli queueservice queue list

Description

list queue

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Responses

NameDescriptionExample
countCount20
queue_urlsQueue URL List[‘https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue’, ‘https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2’]

1.6.2 - 1.1

scp-cli queueservice queue list

Description

list queue

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270220

Responses

NameDescriptionExample
countCount20
queue_urlsQueue URL List[‘https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue’, ‘https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2’]

1.6.3 - 1.0

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

Description

list queue

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260919

Parameters

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

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID8c9f6c1c928a45b4bbd1e4da5531d656
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
encryptionEncryption
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameQueue nametest-queue.fifo
number_wait_messagesNumber of waiting messages10
stateQueue stateACTIVE
typeQueue TypeFIFO

1.7 - Set Acl

1.7.1 - 1.2

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

Description

update an acl policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
arrayAccess Allowed IP List192.168.0.0

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

1.7.2 - 1.1

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

Description

update an acl policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270220

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
arrayAccess Allowed IP List192.168.0.0

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

1.7.3 - 1.0

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

Description

update an acl policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
arrayAccess Allowed IP List192.168.0.0

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

1.8 - Show Queue

1.8.1 - 1.2

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

Description

show a specific queue

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID8c9f6c1c928a45b4bbd1e4da5531d656
allow_ip_accessAccess Allowed IP List[‘192.168.0.0’, ‘172.16.0.0/12’]
content_based_deduplicationContent based deduplicationFalse
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
data_key_reuse_periodData key reuse period40
data_key_reuse_period_unitPeriod unitminute
deduplication_scopeDeduplication scopeQueue
descriptionDescriptionQueue description
encryptionEncryption{}
message_retention_periodMessage retention period40
message_retention_period_unitPeriod unitminute
message_sizeMessage size256
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameQueue nametest-queue.fifo
number_wait_messagesNumber of waiting messages10
privatelink_service_idPrivatelink Service ID8c9f6c1c928a45b4bbd1e4da5531d656
stateQueue stateACTIVE
typeQueue TypeFIFO

1.8.2 - 1.1

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

Description

show a specific queue

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270220

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID8c9f6c1c928a45b4bbd1e4da5531d656
allow_ip_accessAccess Allowed IP List[‘192.168.0.0’, ‘172.16.0.0/12’]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
data_key_reuse_periodData key reuse period40
data_key_reuse_period_unitPeriod unitminute
descriptionDescriptionQueue description
encryptionEncryption{}
message_retention_periodMessage retention period40
message_retention_period_unitPeriod unitminute
message_sizeMessage size256
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameQueue nametest-queue.fifo
number_wait_messagesNumber of waiting messages10
privatelink_service_idPrivatelink Service ID8c9f6c1c928a45b4bbd1e4da5531d656
stateQueue stateACTIVE
typeQueue TypeFIFO

1.8.3 - 1.0

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

Description

show a specific queue

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID8c9f6c1c928a45b4bbd1e4da5531d656
allow_ip_accessAccess Allowed IP List[‘192.168.0.0’, ‘172.16.0.0/12’]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
data_key_reuse_periodData key reuse period40
data_key_reuse_period_unitPeriod unitminute
descriptionDescriptionQueue description
encryptionEncryption{}
message_retention_periodMessage retention period40
message_retention_period_unitPeriod unitminute
message_sizeMessage size256
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameQueue nametest-queue.fifo
number_wait_messagesNumber of waiting messages10
stateQueue stateACTIVE
typeQueue TypeFIFO

1.9 - Update Queue Config

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

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS nametest-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
message_size
required
integerMessage size256
message_retention_period_unit
required
stringPeriod unitminute
message_retention_period
required
integerMessage retention period40
data_key_reuse_period
optional
integerData key reuse period40
data_key_reuse_period_unit
optional
****Period unitminute

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

VersionNot Before
1.120270220

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS nametest-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
message_size
required
integerMessage size256
message_retention_period_unit
required
stringPeriod unitminute
message_retention_period
required
integerMessage retention period40
data_key_reuse_period
optional
integerData key reuse period40
data_key_reuse_period_unit
optional
****Period unitminute

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

VersionNot Before
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS nametest-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
message_size
required
integerMessage size256
message_retention_period_unit
required
stringPeriod unitminute
message_retention_period
required
integerMessage retention period40
data_key_reuse_period
optional
integerData key reuse period40
data_key_reuse_period_unit
optional
****Period unitminute

1.10 - Update Queue Deduplication

1.10.1 - 1.2

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

Description

update queue deduplication

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
content_based_deduplication
required
booleanContent based deduplicationFalse

1.11 - Update Queue Deduplication Scope

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

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
deduplication_scope
required
stringDeduplication scopeQueue

1.12 - Update Queue Description

1.12.1 - 1.2

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

Description

update queue description

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
description
required
stringDescriptionQueue description

1.12.2 - 1.1

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

Description

update queue description

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270220

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
description
required
stringDescriptionQueue description

1.12.3 - 1.0

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

Description

update queue description

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260919

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
description
required
stringDescriptionQueue description