一覧取得

ASPIREセルフポータルの仮想マシングループ画面相当の情報を取得します。

GET /api/1.0/vmgroup

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
Response parameters
Name Description Example Data type
totalCount 仮想マシングループ情報件数 120 Number
totalModifyDate 最終更新日時 2023-01-02T11:22:33+0900 String
vmgroups 仮想マシングループ情報一覧 Array
vmgroup 仮想マシングループ情報 Object
siteId サイトID 8eb064f7a5db11e895ea005056898046 String
siteName サイト名 East String
zoneId ゾーンID 0fb296e296924f2bb1a4ce173a0febca String
zoneName ゾーン名 Zone11 String
podId PodID 5f49b71d1a1b4f1baf1dec19b5778943 String
podName Pod名 East_Zone11_VC05 String
tenantId テナントID dc5440d1038b4ffcb3fa56a613a8ac7f String
tenantName テナント名 APU9999999 String
keiyakuResourceId 契約リソースID f05f432d9a774378a30cfa55180786be String
keiyakuResourceName 契約リソース名 VC05_Committed01-APU9999999 String
vmgroupId 仮想マシングループID aeb9bad1a1ac436c88a351f79a73b89b String
vmgroupName 仮想マシングループ名 VMGROUP01 String
status ステータス 実行中 String
comment コメント コメント String
shares 共有情報配列 Array
share 共有情報 Object
shareUserId 共有ユーザID 70a3c8db63bc4585b90c58dacb0706f6 String
shareUserName 共有ユーザ名 Username String
snapshotFlg スナップショットフラグ true Boolean
jobs ジョブ情報配列 Array
job ジョブ情報 Object
jobId ジョブID b93e34d736f84232b65f9b2d79762ebd String
jobName ジョブ名 job01 String
ownerUserId 所有者ユーザID a5dc76bd94ef4abf9536ed441da8a581 String
ownerUserName 所有者ユーザ名 Username 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
vms 仮想マシン情報配列 Array
vm 仮想マシン情報 Object
vmId 仮想マシンID e425ffed959f4d04b279d8e99a310a26 String
vmName 仮想マシン名 VM01 String
storages 仮想マシンストレージ情報配列 Array
storage 仮想マシンストレージ情報 Object
vmStorageId 仮想マシンストレージID 01887c57faef446fb2cca00cef507efa String
storageId ストレージID f1af87b78705473fb7ca7e5924fa1843 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/vmgroup?startindex=11&pagesize=1"
レスポンス例 
  
    {
      "totalCount": 15,
      "totalModifyDate": "2023-06-29T17:44:58+0900",
      "vmgroups": [
          {
              "siteId": "8eb064f7a5db11e895ea005056898046",
              "siteName": "East",
              "zoneId": "0fb296e296924f2bb1a4ce173a0febca",
              "zoneName": "Zone11",
              "podId": "5f49b71d1a1b4f1baf1dec19b5778943",
              "podName": "East_Zone11_VC05",
              "tenantId": "6856a4a04db64fbea0fdea167ad45b7d",
              "tenantName": "APU9999999",
              "keiyakuResourceId": "f05f432d9a774378a30cfa55180786be",
              "keiyakuResourceName": "VC05_Committed_01-APU9999999",
              "vmgroupId": "e979f975a30f4c6699a5c74f9abd6b70",
              "vmgroupName": "TestVMGroup01",
              "status": "停止中",
              "comment": "TestVMG",
      "shares": [
          {
            "shareUserId": "988f1084211a43d7a83af5ef96303bc3",
            "shareUserName": "user01"
          }
      ],
      "snapshotFlg": false,
      "jobs": [
          {
            "jobId": "6def705c60a941b8aecd3eea3f15200e",
            "jobName": "job01"
          }
      ],
      "ownerUserId": "c21b20b59fed47588f2c9ed39b246dc4",
          "ownerUserName": " Testuser01",
          "createDate": "2023-12-01T17:06:01+0900",
          "createUserId": "c21b20b59fed47588f2c9ed39b246dc4",
          "modifyDate": "2023-12-01T17:14:26+0900",
          "modifyUserId": "c21b20b59fed47588f2c9ed39b246dc4",
          "vms": [
            {
              "vmId": "2df129aa4ae84d709ab2b0c32fd72927",
            "vmName": "TESTAPInewVM01",
            "storages": [
              {
                "vmStorageId": "40dfb671aec94b13843744464bf9c623",
                "storageId": "d792e489fd6f45a7adb8142ba5c73211"
              }
            ]
          }
        ]
      }
    }
keyboard_arrow_up