新規作成

ジョブを新規作成します。

POST /api/1.0/job

Request parameters
Name Description Type Data type Required
Authorization Bearer [APIキー] header String True
Job 作成するジョブ情報 body Object True
body parameters
Name Description Example Data type Required
Job ジョブ情報 Object True
jobName ジョブ名 ジョブ名称 String True
groupType ジョブ対象
1:仮想マシングループ
2:仮想マシン 		1 String True
vmgroupId 仮想マシングループID
※groupTypeが1の時必須 		742d1b6103984b26ac20772512fc6823 String
vmId 仮想マシンID
※groupTypeが2の時必須 		01887c57faef446fb2cca00cef507efa String
actionType アクション
1:パワーオン
2:パワーオフ
3:シャットダウン
4:リセット 		1 String True
Comment コメント String
notificationFlg 通知有無 false Boolean True
address 通知先アドレス
※notificationFlgがtrueの場合のみ指定必須。
Email形式。
カンマで分割して複数入力可能。 		aaa@bbb.ccc String
scheduleType スケジュールタイプ
1:1回のみ
2:時間単位
3:日単位
4:週単位
5:月単位(日付指定) 		4 String True
startDate ジョブ開始日 20230412 String True
startTime ジョブ開始時刻 0600 String True
jobInterval ジョブ実行間隔 2 Number
dayOfWeek 曜日 135 String
day 日付 String
Successful Response
Response Code 200 OK
Response Headers Content-type: application/json
Name Description Example Data type
jobId ジョブID 24714aac4703428292a03cd847c9ed62 String
実行例 
  
    # Execute request
    curl -X POST -H "Authorization:$token" -H "Content-Type:application/json" -d '{
        "job": {
            "jobName": "TestJob01",
            "groupType": "2",
            "vmgroupId": "",
            "vmId": "6dd5b295762a4b16ab9e85b8be5aedba",
            "actionType": "3",
            "comment": "",
            "notificationFlg": false,
            "address": "",
            "scheduleType": "1",
            "startDate": "20240309",
            "startTime": "2330",
            "jobInterval": 0,
            "dayOfWeek": "",
            "day": ""
        }
    }' https://eastapi.aspire.gcf.whitecloud.jp/api/1.0/job
レスポンス例 
  
    {"jobId":"4dc0cee119ec44198de63236902006ec"}
keyboard_arrow_up