華為云計(jì)算 云知識(shí) 創(chuàng)建對(duì)端網(wǎng)關(guān)CreateCgw
創(chuàng)建對(duì)端網(wǎng)關(guān)CreateCgw

 

功能介紹

創(chuàng)建租戶用于與VPN網(wǎng)關(guān)相連的對(duì)端網(wǎng)關(guān)

URI

POST /v5/{project_id}/customer-gateways

表1 參數(shù)說明

名稱

類型

是否必選

說明

project_id

String

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

請(qǐng)求消息

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

    名稱

    類型

    是否必選

    描述

    customer_gateway

    CreateCgwRequestBodyContent object

    customer_gateway對(duì)象

    表3 CreateCgwRequestBodyContent

    名稱

    類型

    是否必選

    描述

    name

    String

    • 功能說明:對(duì)端網(wǎng)關(guān)名稱,不填時(shí)會(huì)自動(dòng)生成格式為cgw-****的名稱。例如:cgw-21a3。
    • 取值范圍:1-64個(gè)字符,支持?jǐn)?shù)字、英文字母、中文(\u4e00 - \u9fa5)、_(下劃線)、-(中劃線)。

    route_mode

    String

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

    bgp_asn

    Long

    • 功能說明:對(duì)端網(wǎng)關(guān)的BGP自治域編號(hào)
    • 取值范圍:1-4294967295
    • 默認(rèn)值:65000
    • 約束:當(dāng)route_mode為bgp時(shí)填寫,否則不填。

    ip

    String

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

    ca_certificate

    CaCertificateRequest object

    • 功能說明:對(duì)端網(wǎng)關(guān)CA證書,創(chuàng)建國(guó)密型對(duì)端網(wǎng)關(guān)時(shí)需上傳。
    表4 CaCertificateRequest

    名稱

    類型

    是否必選

    描述

    content

    String

    • 功能說明:對(duì)端網(wǎng)關(guān)CA證書內(nèi)容
    • 取值范圍:1-8192個(gè)字符
  • 請(qǐng)求樣例
    POST https://{Endpoint}/v5/{project_id}/vpn/customer-gateways
    
    {
        "customer_gateway": {
            "name": "cgw-2abf",
            "route_mode": "bgp",
            "bgp_asn": 65000,
            "ip": "10.***.***.21"
            "ca_certificate": {
                "content":"******"
            }
        }
    }

響應(yīng)消息

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

    返回狀態(tài)碼為 201: 創(chuàng)建成功

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

    名稱

    類型

    描述

    customer_gateway

    ResponseCustomerGateway object

    customer_gateway對(duì)象

    request_id

    String

    請(qǐng)求id

    表6 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í)間

    表7 CaCertificate

    名稱

    類型

    描述

    serial_number

    String

    證書序列號(hào)

    signature_algorithm

    String

    簽名算法

    issuer

    String

    證書頒發(fā)者

    subject

    String

    證書使用者

    expire_time

    String

    證書過期時(shí)間

    is_updatable

    boolean

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

  • 響應(yīng)樣例
    {
        "customer_gateway": {
            "id": "03c0aa3d-****-****-****-9d82473765d4",
            "name": "cgw-2abf",
            "route_mode": "bgp",
            "bgp_asn": 65000,
            "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": "7e0383bf-a7fb-461b-a926-baa8a795bf1a"
    }

狀態(tài)碼

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