创建对端网关

功能介绍

创建租户用于与VPN网关相连的对端网关。

调用方法

请参见如何调用API。

URI

POST /v5/{project_id}/customer-gateways

请求消息

• 请求参数

  表2 请求参数

  名称	类型	是否必选	描述
  customer_gateway	CreateCgwRequestBodyContent object	是	customer_gateway对象。

  表3 CreateCgwRequestBodyContent

  名称	类型	是否必选	描述
  name	String	否	功能说明：对端网关名称，不填时会自动生成格式为cgw-****的名称。例如：cgw-21a3。 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线）、.（点）。
  id_type	String	否	功能说明：对端网关标识类型。 取值范围：ip，fqdn。 默认值：ip。
  id_value	String	是	功能说明：对端网关标识值。 取值范围：1-128个字符。当id_type为ip时，应填写点分十进制IPv4地址（如192.168.45.7）；当id_type为fqdn时，应填写大小写字母、数字或特殊符号，不支持以下特殊字符：&、<、>、[、]、\、空格、？。
  bgp_asn	Long	否	功能说明：对端网关的BGP自治域编号。 取值范围：1-4294967295。 约束：当id_type为ip时可填写，否则不填。
  ca_certificate	CaCertificateRequest object	否	功能说明：对端网关CA证书，创建国密型对端网关时需上传。
  tags	Array of VpnResourceTag object	否	功能说明：标签列表。 约束：最多填写20个。

  表4 CaCertificateRequest

  名称	类型	是否必选	描述
  id	String	否	功能说明：证书ID。 格式：36位UUID。
  content	String	否	功能说明：对端网关CA证书内容。 取值范围：1-8192个字符。

  表5 VpnResourceTag

  名称	类型	是否必选	描述
  key	String	是	功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。
  value	String	是	功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。

• 请求样例

  POST https://{Endpoint}/v5/{project_id}/vpn/customer-gateways
  
  {
      "customer_gateway": {
          "name": "cgw-2abf",
          "id_type": "ip",
          "id_value": "10.***.***.21",
          "bgp_asn": 65000,
          "ca_certificate": {
              "content":"******"
          }
      }
  }

响应消息

• 响应参数

  返回状态码为 201: 创建成功。

  表6 响应Body参数列表

  名称	类型	描述
  customer_gateway	ResponseCustomerGateway object	customer_gateway对象。
  request_id	String	请求id。

  表7 ResponseCustomerGateway

  名称	类型	描述
  id	String	功能说明：对端网关的ID。 格式：36位UUID。
  name	String	功能说明：对端网关名称，不填时会自动生成。 取值范围：1-64个字符，包括数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。
  id_type	String	功能说明：对端网关标识类型。 取值范围：ip，fqdn。
  id_value	String	对端网关标识值。
  bgp_asn	Long	对端网关的BGP自治域编号。仅当id_type为ip时返回。
  ca_certificate	CaCertificate object	对端网关CA证书信息。仅当对端网关绑定CA证书时返回。
  created_at	String	创建时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ss。 非UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。
  updated_at	String	最后一次更新时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ss。 非UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。
  tags	Array of VpnResourceTag objects	标签列表。

  表8 CaCertificate

  名称	类型	描述
  id	String	证书ID。
  serial_number	String	证书序列号。
  signature_algorithm	String	签名算法。
  issuer	String	证书颁发者。
  subject	String	证书使用者。
  expire_time	String	证书过期时间。
  is_updatable	boolean	是否能更新证书内容。

  表9 VpnResourceTag

  名称	类型	描述
  key	String	功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。
  value	String	功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。

• 响应样例

  {
      "customer_gateway": {
          "id": "03c0aa3d-demo-a8df-va86-9d82473765d4",
          "name": "cgw-2abf",
          "id_type": "ip",
          "id_value": "10.***.***.21",
          "bgp_asn": 65000,
          "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"
  }

状态码

请参见状态码。