華為云計(jì)算 云知識(shí) 更新對(duì)端網(wǎng)關(guān)UpdateCgw
更新對(duì)端網(wǎng)關(guān)UpdateCgw

 

功能介紹

根據(jù)對(duì)端網(wǎng)關(guān)ID,更新指定的對(duì)端網(wǎng)關(guān)。支持更新名稱(chēng)和更換證書(shū),修改其他參數(shù)需重新創(chuàng)建對(duì)端網(wǎng)關(guān)。

URI

PUT /v5/{project_id}/customer-gateways/{customer_gateway_id}

表1 參數(shù)說(shuō)明

名稱(chēng)

類(lèi)型

是否必選

描述

project_id

String

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

customer_gateway_id

String

對(duì)端網(wǎng)關(guān)ID

請(qǐng)求消息

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

    名稱(chēng)

    類(lèi)型

    是否必選

    描述

    customer_gateway

    UpdateCgwRequestBodyContent object

    customer_gateway對(duì)象

    表3 UpdateCgwRequestBodyContent

    名稱(chēng)

    類(lèi)型

    是否必選

    描述

    name

    String

    • 功能說(shuō)明:網(wǎng)關(guān)名稱(chēng)
    • 取值范圍:1-64個(gè)字符,支持?jǐn)?shù)字、英文字母、中文(\u4e00 - \u9fa5)、_(下劃線)、-(中劃線)。

    ca_certificate

    CaCertificateRequest object

    • 功能說(shuō)明:對(duì)端網(wǎng)關(guān)CA證書(shū)
    表4 CaCertificateRequest

    名稱(chēng)

    類(lèi)型

    是否必選

    描述

    content

    String

    • 功能說(shuō)明:對(duì)端網(wǎng)關(guān)CA證書(shū)內(nèi)容
    • 取值范圍:1-8192個(gè)字符
  • 請(qǐng)求樣例
    PUT https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}
    
    {
        "customer_gateway": {
            "name": "cgw-f846"
            "ca_certificate": {
                "content":"******"
            }
        }
    }

響應(yīng)消息

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

    返回狀態(tài)碼為 200: 更新成功

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

    名稱(chēng)

    類(lèi)型

    描述

    customer_gateway

    ResponseCustomerGateway object

    customer_gateway對(duì)象

    request_id

    String

    請(qǐng)求id

    表6 ResponseCustomerGateway

    名稱(chēng)

    類(lèi)型

    描述

    id

    String

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

    name

    String

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

    route_mode

    String

    • 功能說(shuō)明:對(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

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

    created_at

    String

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

    updated_at

    String

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

    ca_certificate

    CaCertificate object

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

    表7 CaCertificate

    名稱(chēng)

    類(lèi)型

    描述

    serial_number

    String

    證書(shū)序列號(hào)

    signature_algorithm

    String

    簽名算法

    issuer

    String

    證書(shū)頒發(fā)者

    subject

    String

    證書(shū)使用者

    expire_time

    String

    證書(shū)過(guò)期時(shí)間

    is_updatable

    boolean

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

  • 響應(yīng)樣例
    {
        "customer_gateway": {
            "id": "03c0aa3d-****-****-****-9d82473765d4",
            "name": "cgw-f846",
            "route_mode": "bgp",
            "bgp_asn": 65533,
            "ip": "10.***.***.21",
            "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": "2021-12-21T16:49:28.108+08:00",
            "updated_at": "2021-12-21T16:49:28.108+08:00"
        },
        "request_id": "96718f4a-f57a-4e1f-8d05-7d5e903c8d90"
    }

狀態(tài)碼

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