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

APIs

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

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

2 - Create Queue

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"
}

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"
}

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"
}

3 - Delete Acl

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"
}

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"
}

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"
}

4 - Delete Queue

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

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

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

5 - Get Queue Attributes

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"
}

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"
}

6 - List Queue

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"
    ]
}

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"
    ]
}

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"
    ]
}

7 - Set Acl

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"
}

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"
}

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"
}

8 - Show Queue

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"
}

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"
}

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"
}

9 - Update Queue Config

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"
}

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"
}

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"
}

10 - Update Queue Deduplication

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"
}

11 - Update Queue Deduplication Scope

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"
}

12 - Update Queue Description

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"
}

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"
}

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"
}