一覧取得

セルフポータルの仮想マシングループネットワーク画面(仮想マシングループネットワークネットワーク一覧)相当の情報を取得します。

GET /api/1.0/vmgNetwork?vmgroupId={vmgroupId}

※ vmgroupId：情報取得したい仮想マシングループのID

Request parameters
Name Description Type Data type Required
Authorization Bearer [APIキー] header String True
pagesize 取得するデータの取得件数(default:100) query Number
startindex 取得するデータの開始位置 query Number
vmgroupId 仮想マシングループID query String True
Successful Response
Response Code 200 OK
Response Headers Content-type: application/json
Name Description Example Data type
totalCount VMGネットワーク情報件数 120 Number
totalModifyDate 最終更新日時 2023-01-02T11:22:33+0900 String
vmgNetworks VMGネットワーク情報一覧 Array
vmgNetwork VMGネットワーク情報 Object
siteId サイトID 8eb064f7a5db11e895ea005056898046 String
siteName サイト名 East String
zoneId ゾーンID aa2411d6a31911eb961a005056892f69 String
zoneName ゾーン名 Zone11 String
podId PodID 5b17bbe1608d42bea025a8f1b2c3340a String
podName Pod名 East_Zone11_VC05 String
tenantId テナントID e114f2b93493424f9a82f98409ee842b String
tenantName テナント名 APU9999999 String
vmgNetworkId VMGネットワークID 244f802562704fe8a614a57937e1bbc6 String
vmgNetworkName VMGネットワーク名 vmgroup-nw-name String
status ステータス 1 String
networkType ネットワークタイプ区分 2 String
networkConnectKbn ネットワーク接続区分 2 String
comment コメント 仮想マシングループネットワークコメント String
gateway ゲートウェイIPアドレス 192.168.0.1 String
netmask ネットマスク 255.255.255.0 String
dnsFlg DNS使用フラグ false Boolean
dns1 プライマリDNSアドレス 1.1.1.1 String
dns2 セカンダリDNSアドレス 8.8.8.8 String
dnsSuffix DNSサフィックス String
linkNetworkId 接続先ネットワークID 7a107388a10442d29c77cfd3581ff306 String
edgegwId 接続先EdgeGWID a24a3897bc9f40d3ae03e9d830a8dede String
vmgroupId 仮想マシングループID 1d10a85b0d774af6b79264717ed57416 String
ipPools IPプール情報一覧 Array
ipPool IPプール情報 Object
ipPoolId IPプールID 001820cf794a4e7ab15d3c0d83e758ea String
ipBegin IPプール開始IPアドレス 192.169.1.11 String
ipEnd IPプール終了IPアドレス 192.169.1.200 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/vmgNetwork?vmgroupId=12bd9f613ea74079865374584dcf48b0&startindex=11&pagesize=1"
レスポンス例 
  
    {
      "totalCount": 120,
      "totalModifyDate": "2023-01-02T11:22:33+0900",
      "vmgNetworks": [
        {
          "siteId": "8eb064f7a5db11e895ea005056898046",
          "siteName": "East",
          "zoneId": "aa2411d6a31911eb961a005056892f69",
          "zoneName": "Zone11",
          "podId": "5b17bbe1608d42bea025a8f1b2c3340a",
          "podName": " East_Zone11_VC05",
          "tenantId": "e114f2b93493424f9a82f98409ee842b",
          "tenantName": "APU9999999",
          "vmgNetworkId": "244f802562704fe8a614a57937e1bbc6",
          "vmgNetworkName": "vmgroup-nw-name",
          "status": "1",
          "networkType": "2",
          "networkConnectKbn": "2",
          "comment": "",
          "gateway": "192.168.0.1",
          "netmask": "255.255.255.0",
          "dnsFlg": false,
          "dns1": "1.1.1.1",
          "dns2": "8.8.8.8",
          "dnsSuffix": "",
          "linkNetworkId": "7a107388a10442d29c77cfd3581ff306",
          "edgegwId": "a24a3897bc9f40d3ae03e9d830a8dede",
          "vmgroupId": "1d10a85b0d774af6b79264717ed57416",
          "ipPools": [
              {
                  "ipPoolId": "001820cf794a4e7ab15d3c0d83e758ea",
                  "ipBegin": "192.169.1.11",
                  "ipEnd": "192.169.1.200"
              }
          ],
          "createDate": "2020-08-06T17:20:32+0900",
          "createUserId": "a5dc76bd94ef4abf9536ed441da8a581",
          "modifyDate": "2020-08-06T17:20:32+0900",
          "modifyUserId": "a5dc76bd94ef4abf9536ed441da8a581e"
        }
      ]
    }
keyboard_arrow_up