이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
APIs
- 1: Check Queue Name Duplication
- 1.1: 1.0
- 2: Create Queue
- 2.1: 1.0
- 3: Delete Acl
- 3.1: 1.0
- 4: Delete Queue
- 4.1: 1.0
- 5: List Queue
- 5.1: 1.0
- 6: Set Acl
- 6.1: 1.0
- 7: Show Queue
- 7.1: 1.0
- 8: Update Queue Config
- 8.1: 1.0
- 9: Update Queue Description
- 9.1: 1.0
1 - Check Queue Name Duplication
1.1 - 1.0
get /v1/queues/check-duplication
Description
Queue명 중복 체크
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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.0
post /v1/queues
Description
Queue 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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.0
delete /v1/queues/{queue_id}/acl
Description
접근 허용 IP 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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": [
"0.0.0.0",
"192.168.0.0"
]
}
Example HTTP response
Response 200
{
"id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
4 - Delete Queue
4.1 - 1.0
delete /v1/queues/{queue_id}
Description
Queue 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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 - List Queue
5.1 - 1.0
get /v1/queues
Description
Queue 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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 | QueueListResponse |
| 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"
]
}
6 - Set Acl
6.1 - 1.0
post /v1/queues/{queue_id}/acl
Description
접근 허용 IP 추가
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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": [
"0.0.0.0",
"192.168.0.0"
]
}
Example HTTP response
Response 200
{
"id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
7 - Show Queue
7.1 - 1.0
get /v1/queues/{queue_id}
Description
Queue 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | queue_id required | Queue ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QueueShowResponse |
| 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": [
"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"
}
8 - Update Queue Config
8.1 - 1.0
put /v1/queues/{queue_id}/config
Description
Queue 구성 설정 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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 | QueueShowResponse |
| 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": [
"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"
}
9 - Update Queue Description
9.1 - 1.0
put /v1/queues/{queue_id}/description
Description
Queue 설명 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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"
}