Volcano API
๐Ÿš€ API Endpoints

๐Ÿ“จ SQS Management

Message queue operations and management endpoints. 6 endpoints available.

๐ŸŽฏ Quick Stats

๐Ÿ“Š Methods

  • ๐Ÿ” GET: 1 endpoints
  • ๐Ÿ“ POST: 5 endpoints

๐Ÿ” Authentication

All endpoints in this section use the same authentication methods. Choose one:

๐Ÿ”‘ Bearer Token (Recommended)

For user session authentication

Add to request headers:

Authorization: Bearer YOUR_TOKEN

๐Ÿ”ง API Key

For server-side authentication

Add to request headers:

X-API-KEY: YOUR_API_KEY

โš ๏ธ Important: Do not use both authentication methods simultaneously in the same request.

๐Ÿ”— Endpoints Overview

MethodEndpointDescription
๐Ÿ” GET/sqs/queues่Žทๅ–ๅทฒๆณจๅ†Œ็š„้˜Ÿๅˆ—ๅˆ—่กจ
๐Ÿ“ POST/sqs/{queueUrl}/processๆ‰‹ๅŠจๅค„็†ๆŒ‡ๅฎš้˜Ÿๅˆ—็š„ๆถˆๆฏ
๐Ÿ“ POST/sqs/{queueUrl}/startๅฏๅŠจๆŒ‡ๅฎš้˜Ÿๅˆ—็š„่ฝฎ่ฏข
๐Ÿ“ POST/sqs/{queueUrl}/stopๅœๆญขๆŒ‡ๅฎš้˜Ÿๅˆ—็š„่ฝฎ่ฏข
๐Ÿ“ POST/sqs/start-allๅฏๅŠจๆ‰€ๆœ‰้˜Ÿๅˆ—็š„่ฝฎ่ฏข
๐Ÿ“ POST/sqs/stop-allๅœๆญขๆ‰€ๆœ‰้˜Ÿๅˆ—็š„่ฝฎ่ฏข

๐Ÿ“– Detailed Documentation

่Žทๅ–ๅทฒๆณจๅ†Œ็š„้˜Ÿๅˆ—ๅˆ—่กจ

GET/sqs/queues
Full URL
https://api.market.decenctype.com/sqs/queues

๐Ÿ” Authentication: Required (see authentication section above)

Description: ่Žทๅ–ๅทฒๆณจๅ†Œ็š„้˜Ÿๅˆ—ๅˆ—่กจ

Operation ID: getQueues

Response Status:

  • โœ… 200: Success

๐Ÿ“ Example Request

curl -X GET "https://api.market.decenctype.com/sqs/queues" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

ๆ‰‹ๅŠจๅค„็†ๆŒ‡ๅฎš้˜Ÿๅˆ—็š„ๆถˆๆฏ

POST/sqs/{queueUrl}/process
Full URL
https://api.market.decenctype.com/sqs/{queueUrl}/process

๐ŸŽฏ Path Parameters

  • queueUrl (string) - โœ… Required: ้˜Ÿๅˆ— URL๏ผˆ้œ€่ฆ URL ็ผ–็ ๏ผ‰

๐Ÿ“‹ Query Parameters

ParameterTypeRequiredDescription
maxMessagesnumberโŒๆœ€ๅคงๅค„็†ๆถˆๆฏๆ•ฐ

Description: ๆ‰‹ๅŠจๅค„็†ๆŒ‡ๅฎš้˜Ÿๅˆ—็š„ๆถˆๆฏ

Operation ID: processMessages

Response Status:

  • โœ… 201: Success

๐Ÿ“ Example Request

curl -X POST "https://api.market.decenctype.com/sqs/example-queueUrl/process" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

ๅฏๅŠจๆŒ‡ๅฎš้˜Ÿๅˆ—็š„่ฝฎ่ฏข

POST/sqs/{queueUrl}/start
Full URL
https://api.market.decenctype.com/sqs/{queueUrl}/start

๐ŸŽฏ Path Parameters

  • queueUrl (string) - โœ… Required: ้˜Ÿๅˆ— URL๏ผˆ้œ€่ฆ URL ็ผ–็ ๏ผ‰

Description: ๅฏๅŠจๆŒ‡ๅฎš้˜Ÿๅˆ—็š„่ฝฎ่ฏข

Operation ID: startPolling

Response Status:

  • โœ… 201: Success

๐Ÿ“ Example Request

curl -X POST "https://api.market.decenctype.com/sqs/example-queueUrl/start" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

ๅœๆญขๆŒ‡ๅฎš้˜Ÿๅˆ—็š„่ฝฎ่ฏข

POST/sqs/{queueUrl}/stop
Full URL
https://api.market.decenctype.com/sqs/{queueUrl}/stop

๐ŸŽฏ Path Parameters

  • queueUrl (string) - โœ… Required: ้˜Ÿๅˆ— URL๏ผˆ้œ€่ฆ URL ็ผ–็ ๏ผ‰

Description: ๅœๆญขๆŒ‡ๅฎš้˜Ÿๅˆ—็š„่ฝฎ่ฏข

Operation ID: stopPolling

Response Status:

  • โœ… 201: Success

๐Ÿ“ Example Request

curl -X POST "https://api.market.decenctype.com/sqs/example-queueUrl/stop" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

ๅฏๅŠจๆ‰€ๆœ‰้˜Ÿๅˆ—็š„่ฝฎ่ฏข

POST/sqs/start-all
Full URL
https://api.market.decenctype.com/sqs/start-all

๐Ÿ” Authentication: Required (see authentication section above)

Description: ๅฏๅŠจๆ‰€ๆœ‰้˜Ÿๅˆ—็š„่ฝฎ่ฏข

Operation ID: startAllPolling

Response Status:

  • โœ… 201: Success

๐Ÿ“ Example Request

curl -X POST "https://api.market.decenctype.com/sqs/start-all" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

ๅœๆญขๆ‰€ๆœ‰้˜Ÿๅˆ—็š„่ฝฎ่ฏข

POST/sqs/stop-all
Full URL
https://api.market.decenctype.com/sqs/stop-all

๐Ÿ” Authentication: Required (see authentication section above)

Description: ๅœๆญขๆ‰€ๆœ‰้˜Ÿๅˆ—็š„่ฝฎ่ฏข

Operation ID: stopAllPolling

Response Status:

  • โœ… 201: Success

๐Ÿ“ Example Request

curl -X POST "https://api.market.decenctype.com/sqs/stop-all" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"