APIによる利用例

[更新：2025年12月11日]

実行設定の参照 

実行設定を参照します。

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

crontab形式は指定可能なCrontab形式の記法をご参照ください。

# シンプル通知の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

# シンプル通知のAPIを呼び出す場合 (Crontabを指定する場合)
$ curl -X PUT \
  -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/スケジュール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\":\[\"eventbustrigger\"\]\}\}"

トリガーの更新 

既存のトリガーを更新します。

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

$ curl -X PUT \
-u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
-d '{
  "CommonServiceItem": {
    "Name": "trigger-test",
    "Description": "description",
    "Settings": {
      "Source": "//eventbus.sakura.ad.jp/test",
      "ProcessConfigurationID": "実行設定ID",
      "Types": ["aaa"],
      "Conditions": [ {"Key": "a", "Op": "eq", "Values": ["aa"]}, {"Key": "b", "Op": "in", "Values": ["aa", "bb", "cc"]} ] },
      "Provider": { "Class": "eventbustrigger" }
   }
 }'
 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