이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

Queue Service

1: APIs

1.1: Check Queue Name Duplication

1.1.1: 1.2
1.1.2: 1.1
1.1.3: 1.0

1.2: Create Queue

1.2.1: 1.2
1.2.2: 1.1
1.2.3: 1.0

1.3: Delete Acl

1.3.1: 1.2
1.3.2: 1.1
1.3.3: 1.0

1.4: Delete Queue

1.4.1: 1.2
1.4.2: 1.1
1.4.3: 1.0

1.5: Get Queue Attributes

1.5.1: 1.2
1.5.2: 1.1

1.6: List Queue

1.6.1: 1.2
1.6.2: 1.1
1.6.3: 1.0

1.7: Set Acl

1.7.1: 1.2
1.7.2: 1.1
1.7.3: 1.0

1.8: Show Queue

1.8.1: 1.2
1.8.2: 1.1
1.8.3: 1.0

1.9: Update Queue Config

1.9.1: 1.2
1.9.2: 1.1
1.9.3: 1.0

1.10: Update Queue Deduplication

1.10.1: 1.2

1.11: Update Queue Deduplication Scope

1.11.1: 1.2

1.12: Update Queue Description

1.12.1: 1.2
1.12.2: 1.1
1.12.3: 1.0

2: Models

2.1: Acl
2.2: AclRequest
2.3: AclResponse
2.4: CheckDuplicationResponse
2.5: ConfigSetRequest
2.6: DeduplicationScopeSetRequest
2.7: DeduplicationSetRequest
2.8: DescriptionSetRequest
2.9: DescriptionSetResponse
2.10: Encryption
2.11: GetAttribute
2.12: GetAttributesResponse
2.13: Queue
2.14: QueueCreateRequest
2.15: QueueCreateRequestV1_2
2.16: QueueCreateResponse
2.17: QueueListResponseV1_0
2.18: QueueListResponseV1_1
2.19: QueueShowResponseV1_0
2.20: QueueShowResponseV1_1
2.21: QueueShowResponseV1_2
2.22: Tag

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Queue Service 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Version	Status	Not Before
1.2	CURRENT	-
1.1	SUPPORTED	20270220
1.0	SUPPORTED	20260919

OpenAPI URL

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

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

API Version History

1.2

Queue Service가 1.2 버전으로 업데이트되었습니다.

변경사항

[신규] PUT /queues/{queue_id}/deduplication - Queue 중복 제거 설정 API가 추가되었습니다.
[신규] PUI /queues/{queue_id}/deduplication-scope - Queue 중복 제거 범위 설정 API가 추가되었습니다.
[변경] GET /queues/{queue_id} - Queue 상세 조회 API가 변경되었습니다.
응답 모델이 QueueShowResponseV1_2 로 변경되었습니다.
응답 시, 아래와 같은 필드가 추가됩니다.
- content_based_deduplication
- deduplication_scope
[변경] GET /queues/{queue_id}/attributes - Queue 속성 조회 API가 변경되었습니다.
응답 모델이 QueueShowResponseV1_2 로 변경되었습니다.
응답 시, 아래와 같은 필드가 추가됩니다.
- content_based_deduplication
- deduplication_scope
[변경] POST /queues - Queue 생성 API가 변경되었습니다.
요청 모델이 QueueCreateRequestV1_2 로 변경되었습니다.
요청 시, 아래와 같은 필드가 추가됩니다.
- content_based_deduplication
- deduplication_scope
[변경] PUT /queues/{queue_id}/config - Queue 설정 수정 API가 변경되었습니다.
응답 모델이 QueueShowResponseV1_2 로 변경되었습니다.
응답 시, 아래와 같은 필드가 추가됩니다.
- content_based_deduplication
- deduplication_scope

1.1

Queue Service가 1.1 버전으로 업데이트되었습니다.

변경사항

[신규] GET /queues/{queue_id}/attributes - Queue 속성 조회 API가 추가되었습니다.
[변경] GET /queues - Queue 목록 조회 API가 변경되었습니다.
응답 모델이 QueueListResponseV1_1 로 변경되었습니다.
응답 시, 아래와 같은 필드가 추가됩니다.
- queue_urls
응답 시, 아래와 같은 필드가 제거됩니다.
- queues
- page
- size
- sort
[변경] GET /queues/{queue_id} - Queue 상세 조회 API가 변경되었습니다.
응답 모델이 QueueShowResponseV1_1 로 변경되었습니다.
응답 시, 아래와 같은 필드가 추가됩니다.
- privatelink_service_id
[변경] PUT /queues/{queue_id}/config - Queue 설정 수정 API가 변경되었습니다.
응답 모델이 QueueShowResponseV1_1 로 변경되었습니다.
응답 시, 아래와 같은 필드가 추가됩니다.
- privatelink_service_id

1.0

Queue Service가 출시되었습니다.

변경사항

[신규] GET /queues - Queue 목록 조회 API가 추가되었습니다.
[신규] GET /queues/check-duplication - Queue 이름 중복 체크 API가 추가되었습니다.
[신규] GET /queues/{queue_id} - Queue 상세 조회 API가 추가되었습니다.
[신규] POST /queues - Queue 생성 API가 추가되었습니다.
[신규] POST /queues/{queue_id}/acl - 접근 제어 추가 API가 추가되었습니다.
[신규] PUT /queues/{queue_id}/config - Queue 설정 수정 API가 추가되었습니다.
[신규] PUT /queues/{queue_id}/description - Queue 설명 수정 API가 추가되었습니다.
[신규] DELETE /queues - Queue 삭제 API가 추가되었습니다.
[신규] DELETE /queues/{queue_id}/acl - 접근 제어 삭제 API가 추가되었습니다.

1 - APIs

1.1 - Check Queue Name Duplication

1.1.1 - 1.2

get /v1/queues/check-duplication

Description

Queue명 중복 체크

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	name required	Queue명 Example : `test-queue.fifo`	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckDuplicationResponse
400	Bad Request	None
403	Forbidden	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Example HTTP response

Response 200

{
    "result": true
}

1.1.2 - 1.1

get /v1/queues/check-duplication

Description

Queue명 중복 체크

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
query	name required	Queue명 Example : `test-queue.fifo`	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckDuplicationResponse
400	Bad Request	None
403	Forbidden	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.1"

Example HTTP response

Response 200

{
    "result": true
}

1.1.3 - 1.0

get /v1/queues/check-duplication

Description

Queue명 중복 체크

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
query	name required	Queue명 Example : `test-queue.fifo`	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckDuplicationResponse
400	Bad Request	None
403	Forbidden	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 200

{
    "result": true
}

1.2 - Create Queue

1.2.1 - 1.2

post /v1/queues

Description

Queue 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		QueueCreateRequestV1_2

Responses

HTTP Code	Description	Schema
201	Created	QueueCreateResponse
400	Bad Request	None
403	Forbidden	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Request body

{
    "content_based_deduplication": false,
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "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.2.2 - 1.1

post /v1/queues

Description

Queue 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
body	body required		QueueCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	QueueCreateResponse
400	Bad Request	None
403	Forbidden	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.1"

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.2.3 - 1.0

post /v1/queues

Description

Queue 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
body	body required		QueueCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	QueueCreateResponse
400	Bad Request	None
403	Forbidden	None

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 = ko-KR",
"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.2

delete /v1/queues/{queue_id}/acl

Description

접근 허용 IP 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.3.2 - 1.1

delete /v1/queues/{queue_id}/acl

Description

접근 허용 IP 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.1"

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.3.3 - 1.0

delete /v1/queues/{queue_id}/acl

Description

접근 허용 IP 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.4 - Delete Queue

1.4.1 - 1.2

delete /v1/queues/{queue_id}

Description

Queue 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Example HTTP response

Response 204

1.4.2 - 1.1

delete /v1/queues/{queue_id}

Description

Queue 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.1"

Example HTTP response

Response 204

1.4.3 - 1.0

delete /v1/queues/{queue_id}

Description

Queue 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 204

1.5 - Get Queue Attributes

1.5.1 - 1.2

get /v1/queues/{queue_id}/attributes

Description

Queue 속성 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
query	attributes required	Queue 속성 Example : `All`	string	None
query	name required	Queue명 Example : `test-queue.fifo`	string	None

Responses

HTTP Code	Description	Schema
200	OK	GetAttributesResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/attributes?attributes={attributes}&name={name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Example HTTP response

Response 200

{
    "attributes": {
        "approximate_number_of_messages": 10,
        "content_based_deduplication": false,
        "created_at": "2025-05-22T06:21:17.580522",
        "data_key_reuse_period": 40,
        "deduplication_scope": "Queue",
        "message_retention_period": 40,
        "message_size": 256,
        "modified_at": "2025-05-22T06:21:17.580522",
        "queue_srn": "srn:dev2::8c9f6c1c928a45b4bbd1e4da5531d656:kr-west1:queueservice:queue/8c9f6c1c928a45b4bbd1e4da5531d656",
        "type": "FIFO"
    },
    "queue_url": "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue"
}

1.5.2 - 1.1

get /v1/queues/{queue_id}/attributes

Description

Queue 속성 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
query	attributes required	Queue 속성 Example : `All`	string	None
query	name required	Queue명 Example : `test-queue.fifo`	string	None

Responses

HTTP Code	Description	Schema
200	OK	GetAttributesResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/attributes?attributes={attributes}&name={name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = queueservice 1.1"

Example HTTP response

Response 200

{
    "attributes": {
        "approximate_number_of_messages": 10,
        "content_based_deduplication": false,
        "created_at": "2025-05-22T06:21:17.580522",
        "data_key_reuse_period": 40,
        "deduplication_scope": "Queue",
        "message_retention_period": 40,
        "message_size": 256,
        "modified_at": "2025-05-22T06:21:17.580522",
        "queue_srn": "srn:dev2::8c9f6c1c928a45b4bbd1e4da5531d656:kr-west1:queueservice:queue/8c9f6c1c928a45b4bbd1e4da5531d656",
        "type": "FIFO"
    },
    "queue_url": "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue"
}

1.6 - List Queue

1.6.1 - 1.2

get /v1/queues

Description

Queue 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Responses

HTTP Code	Description	Schema
200	OK	QueueListResponseV1_1
400	Bad Request	None
403	Forbidden	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "queue_urls": [
        "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue",
        "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2"
    ]
}

1.6.2 - 1.1

get /v1/queues

Description

Queue 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Responses

HTTP Code	Description	Schema
200	OK	QueueListResponseV1_1
400	Bad Request	None
403	Forbidden	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "queue_urls": [
        "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue",
        "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2"
    ]
}

1.6.3 - 1.0

get /v1/queues

Description

Queue 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Queue명 Example : `test-queue.fifo`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	QueueListResponseV1_0
400	Bad Request	None
403	Forbidden	None

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 = ko-KR",
"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.7 - Set Acl

1.7.1 - 1.2

post /v1/queues/{queue_id}/acl

Description

접근 허용 IP 추가

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.7.2 - 1.1

post /v1/queues/{queue_id}/acl

Description

접근 허용 IP 추가

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.1"

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.7.3 - 1.0

post /v1/queues/{queue_id}/acl

Description

접근 허용 IP 추가

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.8 - Show Queue

1.8.1 - 1.2

get /v1/queues/{queue_id}

Description

Queue 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "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,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.8.2 - 1.1

get /v1/queues/{queue_id}

Description

Queue 상세 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.1"

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "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,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.8.3 - 1.0

get /v1/queues/{queue_id}

Description

Queue 상세 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_0
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "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 Config

1.9.1 - 1.2

put /v1/queues/{queue_id}/config

Description

Queue 구성 설정 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		ConfigSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.2"

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": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "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,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.9.2 - 1.1

put /v1/queues/{queue_id}/config

Description

Queue 구성 설정 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		ConfigSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.1"

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": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "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,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.9.3 - 1.0

put /v1/queues/{queue_id}/config

Description

Queue 구성 설정 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		ConfigSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"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": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "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,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.10 - Update Queue Deduplication

1.10.1 - 1.2

put /v1/queues/{queue_id}/deduplication

Description

Queue 중복 제거 설정 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DeduplicationSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/deduplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Request body

{
    "content_based_deduplication": false
}

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "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,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.11 - Update Queue Deduplication Scope

1.11.1 - 1.2

put /v1/queues/{queue_id}/deduplication-scope

Description

Queue 중복 제거 범위 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DeduplicationScopeSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/deduplication-scope

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Request body

{
    "deduplication_scope": "Queue"
}

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "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,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.12 - Update Queue Description

1.12.1 - 1.2

put /v1/queues/{queue_id}/description

Description

Queue 설명 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DescriptionSetRequest

Responses

HTTP Code	Description	Schema
200	OK	DescriptionSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.2"

Request body

{
    "description": "Queue description"
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.12.2 - 1.1

put /v1/queues/{queue_id}/description

Description

Queue 설명 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DescriptionSetRequest

Responses

HTTP Code	Description	Schema
200	OK	DescriptionSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.1"

Request body

{
    "description": "Queue description"
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.12.3 - 1.0

put /v1/queues/{queue_id}/description

Description

Queue 설명 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DescriptionSetRequest

Responses

HTTP Code	Description	Schema
200	OK	DescriptionSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

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 = ko-KR",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "description": "Queue description"
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

2 - Models

2.1 - Acl

Name	Description	Schema	Default
ip_address required	IP 주소 Example : `192.168.0.0/32`	string

2.2 - AclRequest

Name	Description	Schema	Default
ip_address required	접근 허용 IP 목록 Example : `['192.168.0.0', '172.16.0.0/12']`	array[string]

2.3 - AclResponse

Name	Description	Schema	Default
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string

2.4 - CheckDuplicationResponse

Name	Description	Schema	Default
result required	결과 Example : `True`	boolean

2.5 - ConfigSetRequest

Name	Description	Schema
data_key_reuse_period optional	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	기간 단위 Example : `minute`	any of [enum (minute, hour), null]
encryption optional	암호화	any of [Encryption, null]
message_retention_period required	메시지 보존 기간 Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	기간 단위 Example : `minute`	enum (second, minute, hour, day)
message_size required	메시지 크기 Example : `256` Minimum : `1` Maximum : `256`	integer

2.6 - DeduplicationScopeSetRequest

Name	Description	Schema	Default
deduplication_scope required	중복 제거 범위 Example : `Queue`	enum (Queue, MessageGroup)

2.7 - DeduplicationSetRequest

Name	Description	Schema	Default
content_based_deduplication required	컨텐츠 기반 중복 제거 Example : `False`	boolean

2.8 - DescriptionSetRequest

Name	Description	Schema	Default
description required	설명 Example : `Queue description` Maximum length : `100`	string

2.9 - DescriptionSetResponse

Name	Description	Schema	Default
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string

2.10 - Encryption

Name	Description	Schema	Default
id required	KMS ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	any of [string, null]
name required	KMS명 Example : `test-kms`	any of [string, null]

2.11 - GetAttribute

Name	Description	Schema
approximate_number_of_messages required	대략적인 메시지 수 Example : `10`	any of [string, null]
content_based_deduplication required	컨텐츠 기반 중복 제거 Example : `False`	any of [boolean, null]
created_at required	생성 시간 Example : `2025-05-22T06:21:17.580522`	any of [string (date-time), null]
data_key_reuse_period required	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
deduplication_scope required	중복 제거 범위 Example : `Queue`	any of [enum (Queue, MessageGroup), null]
message_retention_period required	메시지 보존 기간 Example : `40`	any of [integer, null]
message_size required	메시지 크기 Example : `256`	any of [integer, null]
modified_at required	수정 시간 Example : `2025-05-22T06:21:17.580522`	any of [string (date-time), null]
queue_srn required	SRN Example : `srn:dev2::8c9f6c1c928a45b4bbd1e4da5531d656:kr-west1:queueservice:queue/8c9f6c1c928a45b4bbd1e4da5531d656`	any of [string, null]
type required	Queue 유형 Example : `FIFO`	any of [string, null]

2.12 - GetAttributesResponse

Name	Description	Schema	Default
attributes required		any of [GetAttribute, object]
queue_url required	Queue URL Example : `https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue`	string

2.13 - Queue

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
encryption optional	암호화	any of [Encryption, null]
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue명 Example : `test-queue.fifo`	string
number_wait_messages required	대기 메시지 수 Example : `10`	integer
state required	Queue 상태 Example : `ACTIVE`	string
type required	Queue 유형 Example : `FIFO`	string

2.14 - QueueCreateRequest

Name	Description	Schema
data_key_reuse_period optional	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	기간 단위 Example : `minute`	any of [enum (minute, hour), null]
description optional	설명 Example : `Queue description`	any of [string, null]
encryption optional	암호화	any of [Encryption, null]
message_retention_period required	메시지 보존 기간 Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	기간 단위 Example : `minute`	enum (second, minute, hour, day)
message_size required	메시지 크기 Example : `256` Minimum : `1` Maximum : `256`	integer
name required	Queue명 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	태그 목록	any of [array[Tag], null]

2.15 - QueueCreateRequestV1_2

Name	Description	Schema
content_based_deduplication optional	컨텐츠 기반 중복 제거 Example : `False`	any of [boolean, null]
data_key_reuse_period optional	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	기간 단위 Example : `minute`	any of [enum (minute, hour), null]
deduplication_scope optional	중복 제거 범위 Example : `Queue`	any of [enum (Queue, MessageGroup), null]
description optional	설명 Example : `Queue description`	any of [string, null]
encryption optional	암호화	any of [Encryption, null]
message_retention_period required	메시지 보존 기간 Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	기간 단위 Example : `minute`	enum (second, minute, hour, day)
message_size required	메시지 크기 Example : `256` Minimum : `1` Maximum : `256`	integer
name required	Queue명 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	태그 목록	any of [array[Tag], null]

2.16 - QueueCreateResponse

Name	Description	Schema
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
messages required	설명 Example : `Create Queue`	string
state required	Queue 상태 Example : `ACTIVE`	string

2.17 - QueueListResponseV1_0

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
queues required	Queue 목록	array[Queue]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.18 - QueueListResponseV1_1

Name	Description	Schema	Default
count required	합계 Example : `20`	integer
queue_urls required	Queue URL 목록 Example : `['https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue', 'https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2']`	array[string]

2.19 - QueueShowResponseV1_0

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
allow_ip_access optional	접근 허용 IP 목록 Example : `['192.168.0.0', '172.16.0.0/12']`	any of [array[Acl], null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
data_key_reuse_period optional	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	기간 단위 Example : `minute`	any of [enum (minute, hour), null]
description optional	설명 Example : `Queue description`	any of [string, null]
encryption optional	암호화	any of [Encryption, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
message_retention_period required	메시지 보존 기간 Example : `40`	integer
message_retention_period_unit required	기간 단위 Example : `minute`	enum (second, minute, hour, day)
message_size required	메시지 크기 Example : `256`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue명 Example : `test-queue.fifo`	string
number_wait_messages required	대기 메시지 수 Example : `10`	integer
state required	Queue 상태 Example : `ACTIVE`	string
type required	Queue 유형 Example : `FIFO`	string

2.20 - QueueShowResponseV1_1

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
allow_ip_access optional	접근 허용 IP 목록 Example : `['192.168.0.0', '172.16.0.0/12']`	any of [array[Acl], null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
data_key_reuse_period optional	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	기간 단위 Example : `minute`	any of [enum (minute, hour), null]
description optional	설명 Example : `Queue description`	any of [string, null]
encryption optional	암호화	any of [Encryption, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
message_retention_period required	메시지 보존 기간 Example : `40`	integer
message_retention_period_unit required	기간 단위 Example : `minute`	enum (second, minute, hour, day)
message_size required	메시지 크기 Example : `256`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue명 Example : `test-queue.fifo`	string
number_wait_messages required	대기 메시지 수 Example : `10`	integer
privatelink_service_id required	Privatelink Service ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
state required	Queue 상태 Example : `ACTIVE`	string
type required	Queue 유형 Example : `FIFO`	string

2.21 - QueueShowResponseV1_2

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
allow_ip_access optional	접근 허용 IP 목록 Example : `['192.168.0.0', '172.16.0.0/12']`	any of [array[Acl], null]
content_based_deduplication required	컨텐츠 기반 중복 제거 Example : `False`	boolean
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
data_key_reuse_period optional	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	기간 단위 Example : `minute`	any of [enum (minute, hour), null]
deduplication_scope optional	중복 제거 범위 Example : `Queue`	any of [enum (Queue, MessageGroup), null]
description optional	설명 Example : `Queue description`	any of [string, null]
encryption optional	암호화	any of [Encryption, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
message_retention_period required	메시지 보존 기간 Example : `40`	integer
message_retention_period_unit required	기간 단위 Example : `minute`	enum (second, minute, hour, day)
message_size required	메시지 크기 Example : `256`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue명 Example : `test-queue.fifo`	string
number_wait_messages required	대기 메시지 수 Example : `10`	integer
privatelink_service_id required	Privatelink Service ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
state required	Queue 상태 Example : `ACTIVE`	string
type required	Queue 유형 Example : `FIFO`	string

2.22 - Tag

Name	Description	Schema	Default
key required	태그키 Example : `key1`	string
value required	태그값 Example : `value1`	any of [string, null]