API docs by Redocly

シンプルMQ β さくらのクラウドAPI (1.0.0)

Download OpenAPI specification:

URL: https://help.sakura.ad.jp/contact/

Copyright SAKURA internet Inc.

はじめに

「シンプルMQ β」は、ソフトウェア同士を非同期に連携するために、ソフトウェアコンポーネント間でのデータの送受信ができる、マネージド型のメッセージキューサービスです。 シンプルMQのリソースを作成・削除するには、さくらのクラウド コントロールパネルか下記APIを利用します。 キューへのメッセージの送受信などについては、シンプルMQ β API ドキュメント を参照してください。

基本的な使い方

APIキーの発行

APIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。 APIキーは「ユーザーID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。

項目名 APIキー発行時の項目名 このドキュメント内での例
ユーザーID アクセストークン(UUID) 01234567-89ab-cdef-0123-456789abcdef
パスワード アクセストークンシークレット SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM
操作マニュアル

キューの作成

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    },
  • "Success": true,
  • "is_ok": true
}

キュー一覧の取得

クエリパラメータに下記のようにフィルタを設定することでシンプルMQのリソースのみを取得できます /commonserviceitem?{"Filter":{"Provider.Class":"simplemq"}}

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "From": 0,
  • "Count": 1,
  • "Total": 1,
  • "CommonServiceItems": [
    ],
  • "is_ok": true
}

キューの取得

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

キューのリソースID

Responses

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    },
  • "is_ok": true
}

キューの設定変更

キュー名の変更は不可

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

キューのリソースID

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    },
  • "Success": true,
  • "is_ok": true
}

キューの削除

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

キューのリソースID

Responses

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    },
  • "Success": true,
  • "is_ok": true
}

メッセージ数の取得

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

キューのリソースID

Responses

Response samples

Content type
application/json
{
  • "SimpleMQ": {
    },
  • "is_ok": true
}

APIキーの発行

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

キューのリソースID

Responses

Response samples

Content type
application/json
{
  • "SimpleMQ": {
    },
  • "is_ok": true
}

キュー内メッセージの全件削除

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

キューのリソースID

Responses

Response samples

Content type
application/json
{
  • "SimpleMQ": {
    },
  • "is_ok": true
}