EventBus

パラメータ	説明
アクセストークン	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)	実行間隔の単位を指定します。 "min"(分), "hour"(時), "day"(日)のいずれかを指定します。	Destinationがsimplenotificationの場合は省略不可
開始時刻 (StartsAt)	スケジュール実行を開始する時刻のエポックミリ秒	現在時刻

# シンプル通知のAPIを呼び出す場合
$ 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/

その他の利用例 

実行設定の参照 

実行設定を参照します。

パラメータ	説明	省略時のデフォルト値
実行設定ID	実行設定のリソースIDです	省略不可

$ curl -X GET \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/実行設定ID

実行設定の一覧 

実行設定の一覧を取得します。

$ curl -X GET \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  "https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/?\{\"Filter\":\{\"Provider.Class\":\[\"eventbusprocessconfiguration\"\]\}\}"

実行設定の更新 

実行設定を更新します。

パラメータ	説明	省略時のデフォルト値
実行設定ID	実行設定のリソースIDです	省略不可
宛先 (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 PUT \
  -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/実行設定ID

# シンプルMQのAPIを呼び出す場合
$ curl -X PUT \
  -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/実行設定ID

実行設定の削除 

実行設定を削除します。

スケジュールから利用されている実行設定は削除できません。

パラメータ	説明	省略時のデフォルト値
実行設定ID	実行設定のリソースIDです	省略不可

$ curl -X DELETE \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/実行設定ID

スケジュールの参照 

スケジュールを参照します。

パラメータ	説明	省略時のデフォルト値
スケジュールID	スケジュールのリソースIDです	省略不可

$ curl -X GET \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/スケジュールID

スケジュールの一覧 

スケジュールの一覧を取得します。

$ curl -X GET \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  "https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/?\{\"Filter\":\{\"Provider.Class\":\[\"eventbusschedule\"\]\}\}"

スケジュールの更新 

スケジュールを更新します。

パラメータ	説明	省略時のデフォルト値
スケジュールID	スケジュールのリソースIDです	省略不可
実行設定ID (ProcessConfigurationID)	実行設定のリソースIDです	省略不可
実行間隔 (RecurringStep)	繰り返し実行する間隔を指定します。 1分毎に実行するのであれば1を指定し、実行間隔単位でminを指定します。	省略不可
実行間隔単位 (RecurringUnit)	実行間隔の単位を指定します。 "min"(分), "hour"(時), "day"(日)のいずれかを指定します。	Destinationがsimplenotificationの場合は省略不可
開始時刻 (StartsAt)	スケジュール実行を開始する時刻のエポックミリ秒	現在時刻

# シンプル通知のAPIを呼び出す場合
$ curl -X PUT \
  -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/スケジュールID

スケジュールの削除 

スケジュールを削除します。

パラメータ	説明	省略時のデフォルト値
スケジュールID	スケジュールのリソースIDです	省略不可

$ curl -X DELETE \
  -u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
  https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/スケジュールID

用語集 

本サービスで使用される主な用語と概念を説明します。

ジョブ 

EventBusが実行する処理

実行設定 

ジョブをどのように実行するかの設定

スケジュール 

イベントを発生させる周期の設定