シンプルMQ β API (1.0.0)

Download OpenAPI specification:Download


Copyright SAKURA internet Inc.

はじめに

「シンプルMQ β」は、ソフトウェア同士を非同期に連携するために、ソフトウェアコンポーネント間でのデータの送受信ができる、マネージド型のメッセージキューサービスです。 シンプルMQを使うには、さくらのクラウド コントロールパネルでシンプルMQのキューを作成します。 キューを作成するとAPIキーが発行されます。 APIリクエストは、そのキーを Auhorization headerBearer token に使用します。

APIエンドポイント:https://simplemq.tk1b.api.sacloud.jp

メッセージのsend

キューに対するメッセージのsend (enqueue)

Authorizations:
ApiKeyAuth
path Parameters
queueName
required
string (QueueName) [ 5 .. 64 ] characters ^[0-9a-zA-Z]+(-[0-9a-zA-Z]+)*$
Example: my-own-queue-00

キュー名

Request Body schema: application/json
required
content
required
string (MessageContent) <= 256000 characters ^[0-9a-zA-Z+/=]*$

メッセージ本文

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": {
    }
}

メッセージのreceive

キューに対するメッセージのreceive (dequeue)

Authorizations:
ApiKeyAuth
path Parameters
queueName
required
string (QueueName) [ 5 .. 64 ] characters ^[0-9a-zA-Z]+(-[0-9a-zA-Z]+)*$
Example: my-own-queue-00

キュー名

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "messages": [
    ]
}

メッセージのタイムアウト延長

メッセージのタイムアウトをキューの設定値で延長

Authorizations:
ApiKeyAuth
path Parameters
queueName
required
string (QueueName) [ 5 .. 64 ] characters ^[0-9a-zA-Z]+(-[0-9a-zA-Z]+)*$
Example: my-own-queue-00

キュー名

messageId
required
string (MessageId) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
Example: 0193b878-1b25-7775-87f5-9c698206a7e7

メッセージID

Responses

Response samples

Content type
application/json
{
  • "result": "success"
}

メッセージの削除

読み取り済みのメッセージを削除 (ack)

Authorizations:
ApiKeyAuth
path Parameters
queueName
required
string (QueueName) [ 5 .. 64 ] characters ^[0-9a-zA-Z]+(-[0-9a-zA-Z]+)*$
Example: my-own-queue-00

キュー名

messageId
required
string (MessageId) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
Example: 0193b878-1b25-7775-87f5-9c698206a7e7

メッセージID

Responses

Response samples

Content type
application/json
{
  • "result": "success"
}