一覧取得

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

GET /api/1.0/vm

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
vms 仮想マシン情報一覧 Array
vm 仮想マシン情報 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
vmId 仮想マシンID 01887c57faef446fb2cca00cef507efa String
vmName 仮想マシン名 VM01 String
status ステータス 1 String
guestName ゲスト名 computername String
comment コメント コメント String
cpuHotAddFlg 仮想CPUホットアドフラグ false Boolean
memoryHotAddFlg メモリホットアドフラグ false Boolean
timeSyncFlg ゲスト時刻同期フラグ false Boolean
mediaInFlg メディア挿入フラグ true Boolean
guestOsType ゲストOSコード
※ 3.パラメータ詳細：guestOsType 		01001 String
vcpu 仮想CPU数 4 Number
cpuCorePerSocket ソケットあたりのコア数 2 Number
memory 仮想メモリ 1024 Number
hwVersion 仮想ハードウェアバージョン
※ 3.パラメータ詳細：hwVersion 		vmx-11 String
firmwareKbn ファームウェア区分
1:BIOS
2:EFI 		1 String
bootSecureBootFlg セキュアブートフラグ false Boolean
bootDelayTime 起動遅延時間 10 Number
bootBiosSetupFlg 強制セットアップフラグ false Boolean
snapshotFlg スナップショットフラグ true Boolean
vmgroupId 仮想マシングループID 1d10a85b0d774af6b79264717ed57416 String
vmgroupName 仮想マシングループ名 VMGROUP01 String
storages 仮想マシンストレージ情報配列 Array
storage 仮想マシンストレージ情報 Object
vmStorageId 仮想マシンストレージID 01887c57faef446fb2cca00cef507efa String
size ストレージサイズ 100 Number
busType バスタイプ
※ 3.パラメータ詳細：busType 		Lsilogocsas String
busNo バスNo 0 String
unitNo ユニットNo 0 String
storageId ストレージID f1af87b78705473fb7ca7e5924fa1843 String
storageName ストレージ名 VC05_ST01_SSD_BK0 String
nics 仮想マシンNIC情報配列 Array
nic 仮想マシンNIC情報 Object
nicId 仮想マシンNICID 4d8de6382bda48c58757fc8f280715d0 String
nicNo NIC No 0 String
primaryKbn プライマリ区分
1:プライマリ
0:プライマリ以外 		1 String
networkId ネットワークID 9e404e21ead341d3acf37816e402a1e0 String
networkName ネットワーク名 TestNW01 String
networkAdapterName ネットワークアダプタ名
※ 3.パラメータ詳細：networkAdapterName 		VMXNET3 String
ipAddressKbn IPアドレス区分
01:固定IPプール
02:手動
03:DHCP 		01 String
ipAddress IPアドレス 192.168.2.2 String
macAddress MACアドレス 00:50:56:88:2c:00 String
guestOs 仮想マシンゲストOS情報
guestOsCustomizeFlg ゲストOS変更フラグ false Boolean
adminPwdResetFlg ADMINパスワード リセットフラグ true Boolean
adminPwdKbn ADMINパスワード区分
1:自動生成
2:手動 		1 String
adminPwd ADMINパスワード *** String
adminAutoLoginFlg ADMIN自動ログインフラグ true Boolean
adminAutoLoginCount ADMIN自動ログインカウント 10 Number
initialLoginPwdChangeFlg 自動ログインパスワード変更フラグ true Boolean
domainJoinFlg ドメイン参加フラグ true Boolean
domainName ドメイン名 Domain String
domainUserName ドメインユーザ名 domainuser String
domainUserPwd ドメインユーザ パスワード *** String
domainOu ドメインOU String
customScript カスタムスクリプト echo Test script started\\r\\necho Test script end String
jobs ジョブ情報配列 Array
job ジョブ情報 Object
jobId ジョブID b93e34d736f84232b65f9b2d79762ebd String
jobName ジョブ名 job01 String
startupOrder 仮想マシン起動順番 2 Number
startupActionKbn 仮想マシン開始アクション区分
0:なし
1:パワーオン
 1 String
startupWaitTime 仮想マシン起動待機時間(秒) 30 Number
stopActionKbn 仮想マシン停止アクション区分
0:シャットダウン
1:パワーオフ 		1 String
stopWaitTime 仮想マシン停止待機時間(秒) 10 Number
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/vm?startindex=11&pagesize=1"
レスポンス例 
  
    {
      "totalCount": 111,
      "totalModifyDate": "2023-06-29T17:44:58+0900",
      "vms": [
          {
            "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",
            "vmId": "e84daa8cd47e4104bd04dbf134218c72",
            "vmName": "TestAPInewVM01",
            "status": "パワーオフ",
            "guestName": "TestAPInewVM01",
            "comment": "コメント",
            "cpuHotAddFlg": true,
            "memoryHotAddFlg": true,
            "timeSyncFlg": false,
            "mediaInFlg": false,
            "guestOsType": "01001",
            "vcpu": 2,
            "cpuCorePerSocket": 1,
            "memory": 1024,
            "hwVersion": "vmx-17",
            "firmwareKbn": "1",
            "bootSecureBootFlg": false,
            "bootDelayTime": 10,
            "bootBiosSetupFlg": false,
            "snapshotFlg": false,
            "vmgroupId": "e979f975a30f4c6699a5c74f9abd6b70",
            "vmgroupName": "TestVMGroup01",
            "storages": [
              {
                "vmStorageId": "900e4766eb5b4db398783bfee59f1d03",
                "size": 10,
                "busType": "lsilogocsas",
                  "busNo": "0",
                  "unitNo": "0",
                  "storageId": "e86e407045ad401f9a3602beed1dfb54",
                  "storageName": "VC05_ST01_SSD1_BK0"
              }
            ],
            "nics": [
              {
                "nicId": "0c0341602b5e41d5b2524b57cd2992e2",
                "nicNo": "0",
                "primaryKbn": "1",
                "networkId": "4e85e808043743be8a1bbf773f9fc010",
                "networkName": "VMGNW01",
                "networkAdapterName": "VMXNET3",
                "ipAddressKbn": "01",
                "ipAddress": "51.51.51.11",
                "macAddress": "00:50:56:ba:e3:21"
              }
            ],
            "guestOs": {
                "guestOsCustomizeFlg": false,
                "adminPwdResetFlg": false,
                "adminPwdKbn": "",
                "adminPwd": "",
                "adminAutoLoginFlg": false,
                "adminAutoLoginCount": 0,
                "initialLoginPwdChangeFlg": false,
                "domainJoinFlg": false,
                "domainName": "",
                "domainUserName": "",
                "domainUserPwd": "",
                "domainOu": "",
                "customScript": ""
            },
            "jobs": [
                {
                  "jobId": "908bef9bcc1d4524b427ecf68a2317a7",
                  "jobName": "job01"
                }
            ],
            "startupOrder": 1,
            "startupActionKbn": "0",
            "startupWaitTime": 0,
            "stopActionKbn": "0",
            "stopWaitTime": 0,
            "createDate": "2023-06-29T16:34:35+0900",
            "createUserId": "be888fe0ca604895b2241b702b387762",
            "modifyDate": "2023-06-29T19:30:55+0900",
            "modifyUserId": "be888fe0ca604895b2241b702b387762"
        }
     ]
  }
keyboard_arrow_up