一覧取得

セルフポータルのEdgeゲートウェイ画面(Edgeゲートウェイ一覧)相当の情報を取得します。

GET /api/1.0/edgegw

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 EdgeGW情報件数 120 Number
totalModifyDate 最終更新日時 2023-01-02T11:22:33+0900 String
edgegws EdgeGW情報一覧 Array
edgegw EdgeGW情報 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
edgegwId EdgeGWID 00fc221f0e8447789a78bdd4fc4aa6a6 String
edgegwName EdgeGW名 APU9999999-EdgeGW01 String
comment コメント EdgeGWコメント String
edgegwIfs EdgeGWIF情報一覧 Array
edgegwIf EdgeGWIF情報 Object
edgegwIfName EdgeGWIF名 APU9999999-EdgeGW01-00 String
connectNetworkId 接続先ネットワークID 01252c89eda44597b3fa3a4770cc5bbf String
ipaddress IPアドレス 192.168.0.1 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/edgegw?startindex=11&pagesize=1"
レスポンス例 
  
    {
      "totalCount": 120,
      "totalModifyDate": "2023-01-02T11:22:33+0900",
      "edgegws": [
        {
          "siteId": "8eb064f7a5db11e895ea005056898046",
          "siteName": "East",
          "zoneId": "aa2411d6a31911eb961a005056892f69",
          "zoneName": "Zone11",
          "podId": "5b17bbe1608d42bea025a8f1b2c3340a",
          "podName": "East_Zone11_VC05",
          "tenantId": "e114f2b93493424f9a82f98409ee842b",
          "tenantName": "APU9999999",
          "edgegwId": "00fc221f0e8447789a78bdd4fc4aa6a6",
          "edgegwName": "APU9999999-EdgeGW01",
          "comment": "",
          "edgegwIfs": [
            {
              "edgegwIfName": "APU9999999-EdgeGW01-00",
              "connectNetworkId": "01252c89eda44597b3fa3a4770cc5bbf",
              "ipaddress": "192.168.0.1"
            }
          ],
          "createDate": "2020-08-06T17:20:32+0900",
          "createUserId": "a5dc76bd94ef4abf9536ed441da8a581",
          "modifyDate": "2020-08-06T17:20:32+0900",
          "modifyUserId": "a5dc76bd94ef4abf9536ed441da8a581"
        }
      ]
    }
keyboard_arrow_up