API利用の基本手順

[更新：2025年12月11日]

EventBusの利用を開始するには以下の手順が必要になります。

「実行設定」の作成

「実行設定」のシークレット設定

「スケジュール」の作成

注意事項 

さくらのクラウドAPIの利用方法など、一般的な情報については APIドキュメントを参照ください。

APIを実行するためには、APIキーに「作成・削除」のアクセスレベルが必要になります。
詳細は、アクセスレベルのページをご覧ください。

APIキーの作成 

APIキーの発行方法は APIキーをご覧ください。

以降の説明ではAPIキーを以下のように表現します。

パラメータ	説明
アクセストークン	APIキーのアクセストークンです。例：ACCESS_TOKEN と表示しています。
アクセストークンシークレット	APIキーのアクセストークンシークレットです。例：ACCESS_TOKEN_SECRET と表示しています

実行設定の作成 

どのようなジョブを実行するかの設定を登録します。

パラメータ	説明	省略時のデフォルト値
宛先 (Destination)	ジョブが呼び出すAPIの宛先を指定します。 "simplenotification"(シンプル通知)または"simplemq"(シンプルMQ)を指定します。	省略不可
通知先グループID (group_id)	シンプル通知の通知先グループのリソースID	Destinationがsimplenotificationの場合は省略不可
メッセージ (message)	通知するメッセージ内容	Destinationがsimplenotificationの場合は省略不可
キュー名 (queue_name)	シンプルMQのキュー名	Destinationがsimplemqの場合は省略不可
コンテンツ (content)	シンプルMQに送るコンテンツ	Destinationがsimplemqの場合は省略不可

# シンプル通知のAPIを呼び出す場合
$ curl -X POST \
 -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
 -d '{
   "CommonServiceItem": {
     "Name": "example",
     "Description": "example",
     "Settings": {
       "Destination": "simplenotification",
       "Parameters": "{\"group_id\": \"通知先グループID\", \"message\":\"メッセージ\"}"
     },
     "Provider": {
       "Class": "eventbusprocessconfiguration"
     }
   }
 }' \
 https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/

# シンプルMQのAPIを呼び出す場合
$ curl -X POST \
 -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
 -d '{
   "CommonServiceItem": {
     "Name": "example",
     "Description": "example",
     "Settings": {
       "Destination": "simplemq",
       "Parameters": "{\"queue_name\": \"キュー名\", \"content\":\"コンテンツ\"}"
     },
     "Provider": {
       "Class": "eventbusprocessconfiguration"
     }
   }
 }' \
 https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/

実行設定のシークレット設定/更新 

シンプル通知やシンプルMQのAPIを呼び出す際に使用するシークレットを登録します。

パラメータ	説明	省略時のデフォルト値
実行設定ID	実行設定のリソースIDです	省略不可
アクセストークン (AccessToken)	APIキーのアクセストークンです。	実行設定のDestinationがsimplenotificationの場合は省略不可
アクセストークンシークレット (AccessTokenSecret)	APIキーのアクセストークンシークレットです。	実行設定のDestinationがsimplenotificationの場合は省略不可
APIキー (APIKey)	シンプルMQのAPIキーです。	実行設定のDestinationがsimplemqの場合は省略不可

# シンプル通知のAPIを呼び出す場合
$ curl -X PUT \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  -d '{
     "Secret": {
       "AccessToken": "アクセストークン",
       "AccessTokenSecret": "アクセストークンシークレット"
     }
  }' \
  https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/実行設定ID/eventbus/processconfiguration/set-secret

# シンプルMQのAPIを呼び出す場合
$ curl -X PUT \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  -d '{
     "Secret": {
       "APIKey": "APIキー"
     }
  }' \
  https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/実行設定ID/eventbus/processconfiguration/set-secret

スケジュールの作成 

どのようなジョブを実行するかの設定を登録します。

パラメータ	説明	省略時のデフォルト値
実行設定ID (ProcessConfigurationID)	実行設定のリソースIDです	省略不可
実行間隔 (RecurringStep)	繰り返し実行する間隔を指定します。 1分毎に実行するのであれば1を指定し、実行間隔単位でminを指定します。	RecurringUnit/RecurringStep または Crontab の指定必須 (併用不可)
実行間隔単位 (RecurringUnit)	実行間隔の単位を指定します。 "min"(分), "hour"(時), "day"(日)のいずれかを指定します。	RecurringUnit/RecurringStep または Crontab の指定必須 (併用不可)
crontab形式 (Crontab)	実行間隔をcrontab形式で指定します。例：0 0 * * * は毎日0時に実行されます。	RecurringUnit/RecurringStep または Crontab の指定必須 (併用不可)
開始時刻 (StartsAt)	スケジュール実行を開始する時刻のエポックミリ秒	省略不可

# シンプル通知のAPIを呼び出す場合 (RecurringStep/RecurringUnitを指定する場合)
$ curl -X POST \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  -d '{
    "CommonServiceItem": {
      "Name": "schedule",
      "Description": "description",
      "Settings": {
        "ProcessConfigurationID": "実行設定ID",
        "RecurringStep": 実行間隔,
        "RecurringUnit": "実行間隔単位",
        "StartsAt": 開始時刻
      },
      "Provider": {
        "Class": "eventbusschedule"
      }
    }
  }' \
  https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/

# シンプル通知のAPIを呼び出す場合 (Crontabを指定する場合)
$ curl -X POST \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  -d '{
    "CommonServiceItem": {
      "Name": "schedule",
      "Description": "description",
      "Settings": {
        "ProcessConfigurationID": "実行設定ID",
        "Crontab": "crontab形式",
        "StartsAt": 開始時刻
      },
      "Provider": {
        "Class": "eventbusschedule"
      }
    }
  }' \
  https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/

トリガーの作成 

トリガーはイベントを検知してジョブを実行するものです。
以下はトリガーの作成方法です。

パラメータ	説明	省略時のデフォルト値
Source	イベントソース	省略不可
ProcessConfigurationID	実行設定の ID	省略不可
Types	イベントのタイプを指定する文字列のリスト（指定しない場合全てのイベントタイプにマッチ）	null（すべての値を許容）
Conditions	その他のEventの属性情報の条件を指定するJSON配列。各要素は以下のプロパティを持ちます。・Key: 条件のキー・Values: 条件の値（文字列または文字列配列）・Op: 比較演算子（"in" または "eq"）	null（すべての値を許容）

$ curl -X POST \
-u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
-d '{
  "CommonServiceItem": {
    "Name": "trigger-test",
    "Description": "description",
    "Settings": {
      "Source": "//eventbus.sakura.ad.jp/monitoringsuite/alert",
      "ProcessConfigurationID": "実行設定ID"
    },
    "Provider": {
      "Class": "eventbustrigger"
    }
  }
}' \
https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/

API利用の基本手順

注意事項

APIキーの作成

実行設定の作成

実行設定のシークレット設定/更新

スケジュールの作成

トリガーの作成