API docs by Redocly

EventBus さくらのクラウドAPI (1.0.0)

Download OpenAPI specification:

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

Copyright SAKURA internet Inc.

はじめに

「EventBus」は、さくらのクラウド上でイベント駆動型の処理を実現するためのサービスです。 EventBusのリソース（実行設定・スケジュール）を作成・削除するには、さくらのクラウド コントロールパネルか下記APIを利用します。 詳細はEventBus クラウドマニュアルを参照してください。

基本的な使い方

APIキーの発行

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

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

実行設定・スケジュール・トリガーの一覧取得

Provider.Classでeventbusschedule、eventbustriggerまたはeventbusprocessconfigurationを指定してフィルタ可能。 クエリパラメータに下記のようにフィルタを設定することでスケジュール、トリガーまたは実行設定のリソースのみを取得できます /commonserviceitem?{"Filter":{"Provider.Class":"eventbusschedule"}} /commonserviceitem?{"Filter":{"Provider.Class":"eventbustrigger"}} /commonserviceitem?{"Filter":{"Provider.Class":"eventbusprocessconfiguration"}}

Authorizations:
ApiKeyAuth

Responses

Response samples

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

実行設定・スケジュール・トリガーの作成

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
}

実行設定・スケジュール・トリガーの取得

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
}

実行設定のSecret設定

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

キューのリソースID

Request Body schema: application/json
required
required
SacloudAPISecret (object) or SimpleMQSecret (object)

設定するシークレット値

Responses

Request samples

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

Response samples

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