華為云計(jì)算 云知識(shí) 查詢對(duì)端網(wǎng)關(guān)列表ListCgws
查詢對(duì)端網(wǎng)關(guān)列表ListCgws

 

功能介紹

查詢對(duì)端網(wǎng)關(guān)列表

URI

GET /v5/{project_id}/customer-gateways

表1 參數(shù)說明

名稱

類型

是否必選

說明

project_id

String

項(xiàng)目ID,可以通過獲取項(xiàng)目ID獲取項(xiàng)目ID。

表2 請(qǐng)求Query參數(shù)列表

名稱

類型

是否必選

描述

limit

Integer

  • 功能說明:分頁查詢時(shí)每頁返回的記錄數(shù)量
  • 取值范圍:0-200
  • 默認(rèn)值:200

marker

String

  • 功能說明:查詢本頁的起始標(biāo)記位,為空時(shí)為查詢第一頁。查詢下一頁的marker可以根據(jù)上一頁響應(yīng)的page_info對(duì)象中的next_marker填寫。
  • 約束:必須與limit一起使用。

請(qǐng)求消息

  • 請(qǐng)求參數(shù)

  • 請(qǐng)求樣例
    GET https://{Endpoint}/v5/{project_id}/customer-gateways?limit={limit}&marker={marker}

響應(yīng)消息

  • 響應(yīng)參數(shù)

    返回狀態(tài)碼為 200: 查詢成功

    表3 響應(yīng)Body參數(shù)列表

    名稱

    類型

    描述

    customer_gateways

    Array of

    ResponseCustomerGateway objects

    customer_gateway對(duì)象

    total_count

    Long

    租戶下對(duì)端網(wǎng)關(guān)總數(shù)

    page_info

    PageInfo object

    分頁信息

    request_id

    String

    請(qǐng)求id

    表4 ResponseCustomerGateway

    名稱

    類型

    描述

    id

    String

    • 功能說明:對(duì)端網(wǎng)關(guān)的ID
    • 格式:36位UUID

    name

    String

    • 功能說明:對(duì)端網(wǎng)關(guān)名稱,不填時(shí)會(huì)自動(dòng)生成
    • 取值范圍:1-64個(gè)字符,包括數(shù)字、英文字母、中文(\u4e00 - \u9fa5)、_(下劃線)、-(中劃線)。

    route_mode

    String

    • 功能說明:對(duì)端網(wǎng)關(guān)路由模式
    • 取值范圍:static,bgp。

    bgp_asn

    Long

    對(duì)端網(wǎng)關(guān)的BGP自治域編號(hào)。僅當(dāng)route_mode為bgp時(shí)返回。

    ip

    String

    • 功能說明:對(duì)端網(wǎng)關(guān) ip地址
    • 格式:ipv4類型地址。例如:10.***.***.21。

    ca_certificate

    CaCertificate object

    對(duì)端網(wǎng)關(guān)CA證書信息。僅當(dāng)對(duì)端網(wǎng)關(guān)綁定CA證書時(shí)返回。

    created_at

    String

    創(chuàng)建時(shí)間

    updated_at

    String

    最后一次更新時(shí)間

    表5 CaCertificate

    名稱

    類型

    描述

    serial_number

    String

    證書序列號(hào)

    signature_algorithm

    String

    簽名算法

    issuer

    String

    證書頒發(fā)者

    subject

    String

    證書使用者

    expire_time

    String

    證書過期時(shí)間

    is_updatable

    boolean

    是否能更新證書內(nèi)容

    表6 PageInfo

    名稱

    類型

    描述

    next_marker

    String

    下一頁的marker,值為上一次查詢響應(yīng)中最后一個(gè)資源的創(chuàng)建時(shí)間。

    current_count

    Integer

    當(dāng)前列表中資源數(shù)量。若小于查詢請(qǐng)求傳入的limit則表示最后一頁。

  • 響應(yīng)樣例
    {
        "customer_gateways": [{
            "id": "e67d6e27-****-****-****-be9a0f0168e9",
            "name": "cgw-a45b",
            "route_mode": "bgp",
            "bgp_asn": 65588,
            "ip": "100.***.***.81",
            "ca_certificate": {
                "serial_number": "14257156674311863338",
                "signature_algorithm": "SM3WITHSM2",
                "issuer": "C=CN,O=a0002,CN=XXX",
                "subject": "C=CN,O=a0002,CN=XXX",
                "expire_time": "2024-05-22T07:34:22Z",
                "is_updatable": true
            },
            "created_at": "2022-11-28T07:36:24.923Z",
            "updated_at": "2022-11-28T07:36:24.923Z"
        }, {
            "id": "312067bb-****-****-****-09dc941bbffc",
            "name": "cgw-21a3",
            "route_mode": "static",
            "ip": "100.***.***.55",
            "ca_certificate": null,
            "created_at": "2022-11-28T06:25:01.937Z",
            "updated_at": "2022-11-28T06:25:01.937Z"
        }],
        "total_count": 2,
        "page_info": {
            "next_marker": "2022-11-28T06:25:01.937Z",
            "current_count": 2
        },
        "request_id": "82a108d9-0929-42e9-adb7-e146c04c587c"
    }

狀態(tài)碼

請(qǐng)參見狀態(tài)碼