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 an Application Programming Interface (API) 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 API. The API is provided as a RESTful API, and it responds in JSON format.

Version

VersionStatusSupported Until
1.0CURRENT-

OpenAPI URL

https://queueservice.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

1 - APIs

1.1 - Check Queue Name Duplication

1.1.1 - 1.0

get /v1/queues/check-duplication

Description

check queue name duplication

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
queryname
required		Queue name
Example : test-queue.fifo
stringNone

Responses

HTTP CodeDescriptionSchema
200OKCheckDuplicationResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/queues/check-duplication?name={name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 200

{
    "result": true
}

1.2 - Create Queue

1.2.1 - 1.0

post /v1/queues

Description

create a queue

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
QueueCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedQueueCreateResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/queues

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "name": "test-queue.fifo",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "messages": "Create Queue",
    "state": "ACTIVE"
}

1.3 - Delete Acl

1.3.1 - 1.0

delete /v1/queues/{queue_id}/acl

Description

delete an acl policy

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathqueue_id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
stringNone
bodybody
required
AclRequest

Responses

HTTP CodeDescriptionSchema
200OKAclResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "ip_address": [
        "0.0.0.0",
        "192.168.0.0"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.4 - Delete Queue

1.4.1 - 1.0

delete /v1/queues/{queue_id}

Description

delete a specific queue

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathqueue_id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/queues/{queue_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 204

1.5 - List Queue

1.5.1 - 1.0

get /v1/queues

Description

list queue

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		Queue name
Example : test-queue.fifo
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKQueueListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/queues

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "queues": [
        {
            "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "encryption": {
                "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
                "name": "test-kms"
            },
            "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "test-queue.fifo",
            "number_wait_messages": 10,
            "state": "ACTIVE",
            "type": "FIFO"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.6 - Set Acl

1.6.1 - 1.0

post /v1/queues/{queue_id}/acl

Description

update an acl policy

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathqueue_id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
stringNone
bodybody
required
AclRequest

Responses

HTTP CodeDescriptionSchema
200OKAclResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "ip_address": [
        "0.0.0.0",
        "192.168.0.0"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.7 - Show Queue

1.7.1 - 1.0

get /v1/queues/{queue_id}

Description

show a specific queue

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathqueue_id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
stringNone

Responses

HTTP CodeDescriptionSchema
200OKQueueShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/queues/{queue_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "0.0.0.0",
        "192.168.0.0"
    ],
    "console_polling_count": 10,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "state": "ACTIVE",
    "type": "FIFO"
}

1.8 - Update Queue Config

1.8.1 - 1.0

put /v1/queues/{queue_id}/config

Description

update queue config

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathqueue_id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
stringNone
bodybody
required
ConfigSetRequest

Responses

HTTP CodeDescriptionSchema
200OKQueueShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/queues/{queue_id}/config

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256
}

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "0.0.0.0",
        "192.168.0.0"
    ],
    "console_polling_count": 10,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "state": "ACTIVE",
    "type": "FIFO"
}

1.9 - Update Queue Description

1.9.1 - 1.0

put /v1/queues/{queue_id}/description

Description

update queue description

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathqueue_id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
stringNone
bodybody
required
DescriptionSetRequest

Responses

HTTP CodeDescriptionSchema
200OKDescriptionSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/queues/{queue_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "description": "Queue description"
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

2 - Models

2.1 - Acl

NameDescriptionSchemaDefault
ip_address
required		IP address
Example : 192.168.0.0
string

2.2 - AclRequest

NameDescriptionSchemaDefault
ip_address
required		Access Allowed IP List
Example : ['0.0.0.0', '192.168.0.0']
array[string]

2.3 - AclResponse

NameDescriptionSchemaDefault
id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
string

2.4 - CheckDuplicationResponse

NameDescriptionSchemaDefault
result
required		Result
Example : True
boolean

2.5 - ConfigSetRequest

NameDescriptionSchemaDefault
data_key_reuse_period
optional		Data key reuse period
Example : 40
any of [integer, null]
data_key_reuse_period_unit
optional		Period unit
Example : minute
any of [enum (minute, hour), null]
encryption
optional		Encryption
any of [Encryption, null]
message_retention_period
required		Message retention period
Example : 40
Minimum : 1
Maximum : 1209600
integer
message_retention_period_unit
required		Period unit
Example : minute
enum (second, minute, hour, day)
message_size
required		Message size
Example : 256
Minimum : 1
Maximum : 256
integer

2.6 - DescriptionSetRequest

NameDescriptionSchemaDefault
description
required		Description
Example : Queue description
Maximum length : 100
string

2.7 - DescriptionSetResponse

NameDescriptionSchemaDefault
id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
string

2.8 - Encryption

NameDescriptionSchemaDefault
id
required		KMS ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
any of [string, null]
name
required		KMS name
Example : test-kms
any of [string, null]

2.9 - Queue

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
encryption
optional		Encryption
any of [Encryption, null]
id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Queue name
Example : test-queue.fifo
string
number_wait_messages
required		Number of waiting messages
Example : 10
integer
state
required		Queue state
Example : ACTIVE
string
type
required		Queue Type
Example : FIFO
string

2.10 - QueueCreateRequest

NameDescriptionSchemaDefault
data_key_reuse_period
optional		Data key reuse period
Example : 40
any of [integer, null]
data_key_reuse_period_unit
optional		Period unit
Example : minute
any of [enum (minute, hour), null]
description
optional		Description
Example : Queue description
any of [string, null]
encryption
optional		Encryption
any of [Encryption, null]
message_retention_period
required		Message retention period
Example : 40
Minimum : 1
Maximum : 1209600
integer
message_retention_period_unit
required		Period unit
Example : minute
enum (second, minute, hour, day)
message_size
required		Message size
Example : 256
Minimum : 1
Maximum : 256
integer
name
required		Queue name
Example : test-queue.fifo
Pattern : ^[a-z][a-z0-9-]*$|^[a-z][a-z0-9-]*\.fifo$
Minimum length : 3
Maximum length : 64
string
tags
optional		Tag List
any of [array[Tag], null]

2.11 - QueueCreateResponse

NameDescriptionSchemaDefault
id
required		Queue ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
string
messages
required		Description
Example : Create Queue
string
state
required		Queue state
Example : ACTIVE
string

2.12 - QueueListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
page
required		page
Example : 0
integer
queues
required		Queue List
array[Queue]
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.13 - QueueShowResponse

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 8c9f6c1c928a45b4bbd1e4da5531d656
string
allow_ip_access
optional		Access Allowed IP List
Example : ['0.0.0.0', '192.168.0.0']
any of [array[Acl], null]
console_polling_count
required		Polling count
Example : 10
integer
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
data_key_reuse_period
optional		Data key reuse period
Example : 40
any of [integer, null]
data_key_reuse_period_unit
optional		Period unit
Example : minute
any of [enum (minute, hour), null]
description
optional		Description
Example : Queue description
any of [string, null]
encryption
optional		Encryption
any of [Encryption, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
message_retention_period
required		Message retention period
Example : 40
integer
message_retention_period_unit
required		Period unit
Example : minute
enum (second, minute, hour, day)
message_size
required		Message size
Example : 256
integer
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Queue name
Example : test-queue.fifo
string
number_wait_messages
required		Number of waiting messages
Example : 10
integer
state
required		Queue state
Example : ACTIVE
string
type
required		Queue Type
Example : FIFO
string

2.14 - Tag

NameDescriptionSchemaDefault
key
required		Tag Key
Example : key1
string
value
required		Tag Value
Example : value1
any of [string, null]