一覧取得

セルフポータルのジョブ画面(ジョブ一覧)相当の情報を取得します。

GET /api/1.0/job

Request parameters
Name Description Type Data type Required
Authorization Bearer [APIキー] header String True
pagesize 取得するデータの取得件数(default:100) query Number
startindex 取得するデータの開始位置 query Number
Successful Response
Response Code 200 OK
Response Headers Content-type: application/json
Name Description Example Data type
totalCount ジョブ情報件数 120 Number
totalModifyDate 最終更新日 2023-01-02T11:22:33+0900 String
jobs ジョブ情報一覧 Array
job ジョブ情報 Object
siteId サイトID 8eb064f7a5db11e895ea005056898046 String
siteName サイト名 East String
zoneId ゾーンID aa2411d6a31911eb961a005056892f69 String
zoneName ゾーン名 Zone11 String
podId PodID 5f49b71d1a1b4f1baf1dec19b5778943 String
podName Pod名 East_Zone11_VC05 String
tenantId テナントID dc5440d1038b4ffcb3fa56a613a8ac7f String
tenantName テナント名 APU9999999 String
jobId ジョブID aeb1dd4432ce46d681e40c81475f0c5a String
jobName ジョブ名 ジョブ名称 String
groupType ジョブ対象
1:仮想マシングループ
2:仮想マシン 		1 String
vmgroupId 仮想マシングループID 742d1b6103984b26ac20772512fc6823 String
vmgroupName 仮想マシングループ名 VMGROUP01 String
vmId 仮想マシンID
groupTypeが2の時のみ出力 		01887c57faef446fb2cca00cef507efa String
vmName 仮想マシン名
groupTypeが2の時のみ出力 		VM01 String
actionType アクション
1:パワーオン
2:パワーオフ
3:シャットダウン
4:リセット 		1 String
comment コメント ジョブコメント String
notificationFlg 通知有無 false Boolean
address 通知先アドレス
notificationFlgがtrueの場合のみ出力 		aaa@bbb.ccc String
scheduleType スケジュールタイプ
1:1回のみ
2:時間単位
3:日単位
4:週単位
5:月単位(日付指定) 		5 String
startDate ジョブ開始日 20230412 String
startTime ジョブ開始時刻 0600 String
jobInterval ジョブ実行間隔 2 Number
dayOfWeek 曜日
1:月～7:日
複数指定の場合、対応する数字を列挙 		135 String
day 日付 String
lastActionDate 前回実行時刻 2023-06-06T17:20:00+0900 String
lastStatus 前回実行結果 SUCCESS String
nextActionDate 次回実行時間 2020-07-06T17:20:00+0900 String
createDate 登録日時 2020-08-06T17:20:32+0900 String
createUserId 登録ユーザID a5dc76bd94ef4abf9536ed441da8a581 String
modifyDate 更新日時 2020-08-06T17:20:32+0900 String
modifyUserId 更新ユーザID a5dc76bd94ef4abf9536ed441da8a581 String
実行例) 11件目から1件表示する場合
# Execute request
curl -i -X GET -H "Authorization:$token" -H "Content-Type:application/json" ¥
"https://eastapi.aspire.gcf.whitecloud.jp/api/1.0/job?startindex=11&pagesize=1"
レスポンス例 
  
    {
      "totalCount": 20,
      "totalModifyDate": "2023-12-07T14:03:40+0900",
      "jobs": [
        {
          "siteId": "5923baabacdf11e8af4f005056802cb3",
          "siteName": "East",
          "zoneId": "d3040613490711ec938e005056802cb3",
          "zoneName": "Zone11",
          "podId": "0f4501d4937c4693bf27d420b3d4d804",
          "podName": "East_Zone11_VC05",
          "tenantId": "2dec53bde11b4a6ead39c64cf6e814a8",
          "tenantName": "APU9999999",
          "jobId": "31727372c8e34f15886ed782a6b7145c",
          "jobName": "TestJob01",
          "groupType": "1",
          "vmgroupId": "27247f999b5b49329df7583aaa8c49a1",
          "vmgroupName": "TestVMGroup01",
          "vmId": "",
          "vmName": "",
          "actionType": "4",
          "comment": "TestJob",
          "notificationFlg": true,
          "address": "aaa@bbb.ccc",
          "scheduleType": "5",
          "startDate": "20231202",
          "startTime": "1714",
          "jobInterval": 1,
          "dayOfWeek": "",
          "day": "28",
          "lastActionDate": "2023-12-02T17:14:00+0900",
          "lastStatus": "ERROR",
          "nextActionDate": "2023-12-28T17:14:00+0900",
          "createDate": "2023-12-01T17:14:50+0900",
          "createUserId": "c21b20b59fed47588f2c9ed39b246dc4",
          "modifyDate": "2023-12-07T14:03:40+0900",
          "modifyUserId": "c21b20b59fed47588f2c9ed39b246dc4"
        }
      ]
    }
keyboard_arrow_up