华为云用户手册

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 vpn_gateway UpdateVgwRequestBodyContent object 是 vpn_gateway对象。 表3 UpdateVgwRequestBodyContent 名称 类型 是否必选 描述 name String 否 功能说明：VPN网关名称。 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线）、.（点）。 local_subnets Array of String 否 功能说明：本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：192.168.52.0/24。 约束：当attachment_type配置为"vpc"时可填写，否则不填。每个VPN网关最多填写50个本端子网。 eip_id_1 String 否 功能说明：有效的EIP的ID，表示绑定新的EIP作为双活VPN网关使用的第一个EIP或主备VPN网关的主EIP。绑定新的EIP前必须先解绑掉原有的EIP。可以通过解绑弹性公网IP解绑VPN网关使用的EIP。 约束：36位UUID，当network_type配置为public时可填写，否则不填。 eip_id_2 String 否 功能说明：有效的EIP的ID，表示绑定新的EIP作为双活VPN网关使用的第二个EIP或主备VPN网关的备EIP。绑定新的EIP前必须先解绑掉原有的EIP。可以通过解绑弹性公网IP解绑VPN网关使用的EIP。 约束：36位UUID，当network_type配置为public时可填写，否则不填。 policy_template PolicyTemplate object 否 功能说明：策略模板。 约束：只有当VPN网关的规格为Professional1-NonFixedIP或Professional2-NonFixedIP时使用，用于更新网关的策略模板。 表4 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike 策略对象。 ipsec_policy IpsecPolicy object ipsec 策略对象。 表5 IkePolicy 名称 类型 描述 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 dh_group String 功能说明：第一阶段密钥交换使用的DH组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 lifetime_seconds Integer 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 取值范围：60-604800，单位：秒。 表6 IpsecPolicy 名称 类型 描述 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 pfs String 功能说明：PFS使用的DH密钥组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 lifetime_seconds Integer 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 取值范围：30-604800，单位：秒。 请求样例 更新固定IP接入网关。 PUT https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id} { "vpn_gateway": { "name": "vpngw-4321", "local_subnets": [ "192.168.0.0/24" ], "eip_id_1": "f1469b4a-demo-a8df-va86-bb7de91cf493", "eip_id_2": "6ad8e297-demo-a8df-va86-da0f885ccb98" } } 更新非固定IP接入VPN网关策略模板。 PUT https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id} { "vpn_gateway":{ "policy_template":{ "ike_policy":{ "authentication_algorithm":"sha2-256", "encryption_algorithm":"aes-128-gcm-16", "dh_group":"group21", "lifetime_seconds":86400 }, "ipsec_policy":{ "authentication_algorithm":"sha2-256", "encryption_algorithm":"aes-128-gcm-16", "pfs":"disable", "lifetime_seconds":3600 } } } }

数据准备 表1 创建VPN连接请求关键参数 参数 说明 取值样例 vgw_id VPN网关ID。 b32d91a4-demo-a8df-va86-e907174eb11d vgw_ip VPN网关EIP的ID。 0c464dad-demo-a8df-va86-c22bb0eb0bde cgw_id 对端网关ID。 5247ae10-demo-a8df-va86-dd36659a7f5d peer_subnets 对端子网。 192.168.44.0/24 psk 预共享密钥。 abcd****

操作步骤 基于关联VPC的VPN网关，创建静态路由模式的VPN连接。 发送“POST https://{endpoint}/v5/{project_id}/vpn-connection”，project_id为项目ID。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下。 { "vpn_connection": { "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", "peer_subnets": [ "192.168.44.0/24" ], "psk": "abcd****" } } 查看请求响应结果。 请求成功时，响应参数如下，id就是VPN连接的ID。 { "vpn_connection": { "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", "name": "vpn-1655", "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", "style": "STATIC", "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", "peer_subnets": ["192.168.44.0/24"], "tunnel_local_address": "169.254.56.225/30", "tunnel_peer_address": "169.254.56.226/30", "enable_nqa": false, "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 86400, "local_id_type": "ip", "local_id": "10.***.***.134", "peer_id_type": "ip", "peer_id": "88.***.***.164", "dpd": { "timeout": 15, "interval": 30, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-11-26T13:41:34.626Z", "updated_at": "2022-11-26T13:41:34.626Z", "enterprise_project_id": "0", }, "request_id": "f74da97d-aa27-4f62-a87c-a33b5706964b" } 查询VPN连接详情。 发送“GET https://{endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}”，project_id为项目ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，响应参数如下，id就是VPN连接的ID。 { "vpn_connection": { "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", "name": "vpn-1655", "status": "DOWN", "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", "style": "STATIC", "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", "peer_subnets": ["192.168.44.0/24"], "tunnel_local_address": "169.254.56.225/30", "tunnel_peer_address": "169.254.56.226/30", "enable_nqa": false, "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 86400, "local_id_type": "ip", "local_id": "10.***.***.134", "peer_id_type": "ip", "peer_id": "88.***.***.164", "dpd": { "timeout": 15, "interval": 30, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-11-26T13:41:34.626Z", "updated_at": "2022-11-26T13:41:34.626Z", "enterprise_project_id": "0", }, "request_id": "104c5608-b68b-462c-af17-ead2fb5ccee4" }

响应消息 响应参数 返回状态码为 204: 删除成功。 响应样例 对端网关上已创建有VPN连接，删除失败。 DELETE https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id} { "error_code": "VPN.0001", "error_msg": "invalid request: customer gateway 575c1722-demo-a8df-va86-dd7f41876332 has connection", "request_id": "c923ac44-1890-48d5-a004-5be6432cf361" }

操作步骤 创建对端网关。 发送“POST https://{endpoint}/v5/{project_id}/customer-gateways”，project_id为项目ID。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下。 { "customer_gateway": { "name": "cgw-3ebf", "id_type": "ip", "id_value": "10.***.***.21" } } 查看请求响应结果。 请求成功时，响应参数如下，id就是对端网关的ID。 1 2 3 4 5 6 7 8 9 10 11 { "customer_gateway": { "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", "name": "cgw-3ebf", "id_type": "ip", "id_value": "10.***.***.21", "created_at": "2021-12-21T16:49:28.108+08:00", "updated_at": "2021-12-21T16:49:28.108+08:00" }, "request_id": "e55783ba-5cc8-40c1-ad81-12cce6f773d2" } 查询对端网关详情。 发送“GET https://{endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}”，project_id为项目ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，响应参数如下，id就是对端网关的ID。 1 2 3 4 5 6 7 8 9 10 11 { "customer_gateway": { "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", "name": "cgw-3ebf", "id_type": "ip", "id_value": "10.***.***.21", "created_at": "2021-12-21T16:49:28.108+08:00", "updated_at": "2021-12-21T16:49:28.108+08:00" }, "request_id": "8cf476c4-c3d4-4516-bfbc-01e2473e549b" }

概述 欢迎使用虚拟专用网络（Virtual Private Network，以下简称VPN）。VPN用于在远端用户和虚拟私有云（Virtual Private Cloud，以下简称VPC）之间建立一条安全加密的公网通信隧道。默认情况下，在虚拟私有云（VPC）中的弹性云服务器无法与用户的数据中心或私有网络进行通信。如果需要将VPC中的弹性云服务器和数据中心或私有网络连通，可以启用VPN功能。 您可以使用本文档提供的API对VPN进行相关操作，如创建、查询、删除、更新等。支持的全部操作请参见API概览。 在调用VPN服务的API之前，请确保已经充分了解VPN服务相关概念，详细信息请参见《虚拟专用网络产品文档》的“产品介绍”章节。 目前VPN分为经典版和企业版两类产品，本文只针对企业版VPN。 父主题： 使用前阅读

响应消息 响应参数 返回状态码为 201: successful operation。 表4 响应Body参数列表 名称 类型 描述 connection_monitor ConnectionMonitorInfo object connection_monitor对象。 request_id String 请求ID。 表5 ConnectionMonitorInfo 名称 类型 描述 id String 功能说明：VPN连接监控ID。 格式：36位UUID。 vpn_connection_id String 功能说明：VPN连接监控对应的VPN连接ID。 格式：36位UUID。 type String 功能说明：监控类型。 取值范围：gateway。 source_ip String VPN连接监控的源地址。 destination_ip String VPN连接监控的目的地址。 proto_type String 功能说明：nqa使用的协议类型。 取值范围：icmp。 响应样例 { "connection_monitor":{ "id":"76f64229-demo-a8df-va86-3907e2815b6d", "vpn_connection_id":"cae286f2-demo-a8df-va86-e22416ca1220", "type":"gateway", "source_ip":"88.***.***.60", "destination_ip":"88.***.***.32", "proto_type":"icmp" }, "request_id": "bd37d16d-387c-41ab-a180-01b649f73590" }

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 connection_monitor CreateConnectionMonitorRequestBodyContent object 是 connection_monitor对象。 表3 CreateConnectionMonitorRequestBodyContent 名称 类型 是否必选 描述 vpn_connection_id String 是 VPN连接监控对应的VPN连接ID。 可以通过查询VPN连接列表查看VPN连接ID。 请求样例 POST https://{Endpoint}/v5/{project_id}/connection-monitors { "connection_monitor": { "vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220" } }

响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 certificate VpnGatewayCertificate object 证书对象。 request_id String 请求ID。 表3 VpnGatewayCertificate 名称 类型 描述 id String 功能说明：VPN网关证书ID。 格式：36位UUID。 name String 功能说明：VPN网关证书名称。 取值范围：3-63个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(英文句点)。 project_id String 功能说明：租户的项目ID。 取值范围：1-64个字符。 vgw_id String 功能说明：VPN网关ID。 格式：36位UUID。 status String 功能说明：网关证书状态。 取值范围：BOUND，FAULT，BINDING。 issuer String 功能说明：国密签名证书颁发者。 取值范围：1-256个字符。 signature_algorithm String 功能说明：国密签名证书签名算法。 取值范围：1-64个字符。 certificate_serial_number String 功能说明：国密签名证书序列号。 取值范围：1-64个字符。 certificate_subject String 功能说明：签名证书使用者。 取值范围：1-256个字符。 certificate_expire_time String 功能范围：国密签名证书过期时间。 certificate_chain_serial_number String 功能说明：CA证书序列号。 取值范围：1-64个字符。 certificate_chain_subject String 功能说明：CA证书使用者。 取值范围：1-256个字符。 certificate_chain_expire_time String 功能说明：CA证书过期时间。 enc_certificate_serial_number String 功能说明：国密加密证书序列号。 取值范围：1-64个字符。 enc_certificate_subject String 功能说明：加密证书使用者。 取值范围：1-256个字符。 enc_certificate_expire_time String 功能说明：国密加密证书过期时间。 created_at String 功能说明：创建时间。 updated_at String 功能说明：更新时间。 响应样例 { "certificate": { "id": "18b81966-demo-a8df-va86-51db2ae6cfbd", "name": "cert-ces-test", "project_id": "06057689f680d5762f7fc008c77b8891", "vgw_id": "b1e94931-demo-a8df-va86-ec906c458ba7", "status": "BOUND", "issuer": "C=CN,ST=Beijing,L=HaiDian,O=GMCert.org,CN=GMCert GM Root CA - 01", "signature_algorithm": "SM3WITHSM2", "certificate_serial_number": "16548506527294397241", "certificate_subject": "C=CN,ST=beijing,L=beijing,O=huawei,OU=vpn,CN=hwcloud-vpn", "certificate_expire_time": "2023-03-21T07:41:39Z", "certificate_chain_serial_number": "12369133709000538078", "certificate_chain_subject": "C=CN,ST=Beijing,L=HaiDian,O=GMCert.org,CN=GMCert GM Root CA - 01", "certificate_chain_expire_time": "2023-03-21T01:31:33Z", "enc_certificate_serial_number": "16548506527294397242", "enc_certificate_subject": "C=CN,ST=beijing,L=beijing,O=huawei,OU=vpn,CN=hwcloud-vpn", "enc_certificate_expire_time": "2023-03-21T07:43:26Z", "created_at": "2023-03-14T07:48:13.705Z", "updated_at": "2023-03-14T07:48:13.887Z" } }

响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 tags Array of ResourceTag objects 资源标签列表。 表3 ResourceTag 名称 类型 描述 key String 标签的键。 values Array of String 标签的值。 响应样例 { "tags":[ { "key":"key1", "values":["value1"] } ] }

URI POST /v5/{project_id}/{resource_type}/{resource_id}/tags/create 表1 参数说明 名称 类型 是否必选 说明 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 resource_type String 是 功能说明：资源类型。 取值范围：vpn-gateway，customer-gateway，vpn-connection。 resource_id String 是 资源ID。

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 tags Array of ResourceTag objects 是 功能说明：标签列表。 约束：最多填写20个。 表3 ResourceTag 名称 类型 是否必选 描述 key String 是 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 否 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 请求样例 POST https://{Endpoint}/v5/{project_id}/{resource_type}/{resource_id}/tags/create { "tags": [{ "key": "key1", "value": "value1" }] }

响应消息 响应参数 返回状态码为 200: 查询成功。 表3 响应Body参数列表 名称 类型 描述 customer_gateways Array of ResponseCustomerGateway objects customer_gateway对象。 total_count Long 租户下对端网关总数。 page_info PageInfo object 分页信息。 request_id String 请求id。 表4 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 标签列表。 表5 CaCertificate 名称 类型 描述 id String 证书ID。 serial_number String 证书序列号。 signature_algorithm String 签名算法。 issuer String 证书颁发者。 subject String 证书使用者。 expire_time String 证书过期时间。 is_updatable boolean 是否能更新证书内容。 表6 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 表7 PageInfo 名称 类型 描述 next_marker String 下一页的marker，值为上一次查询响应中最后一个资源的创建时间。 current_count Integer 当前列表中资源数量。若小于查询请求传入的limit则表示最后一页。 响应样例 { "customer_gateways": [{ "id": "e67d6e27-demo-a8df-va86-be9a0f0168e9", "name": "cgw-a45b", "id_type": "ip", "id_value": "100.***.***.81", "bgp_asn": 65588, "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-demo-a8df-va86-09dc941bbffc", "name": "cgw-21a3", "id_type": "fqdn", "id_value": "123******456", "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" }

URI GET /v5/{project_id}/customer-gateways 表1 参数说明 名称 类型 是否必选 说明 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 表2 请求Query参数列表 名称 类型 是否必选 描述 limit Integer 否 功能说明：分页查询时每页返回的记录数量。 取值范围：0-200。 默认值：200。 marker String 否 功能说明：查询本页的起始标记位，为空时为查询第一页。查询下一页的marker可以根据上一页响应的page_info对象中的next_marker填写。 约束：必须与limit一起使用。

响应消息 响应参数 返回状态码为 204: 删除成功。 响应样例 冻结场景下删除失败。 DELETE https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} { "error_code":"VPN.0001", "error_msg":"invalid request: ILLEGAL not allowed delete vpnConnection", "request_id":"76b771cb-3b2a-151a-5bed-fdf5df12ff82" }

响应消息 响应参数 返回状态码为 204: 删除成功。 响应样例 VPN状态为“创建中”，删除失败。 { "error_code":"VPN.0003", "error_msg":"resource (type=GATEWAY, ID=ff9bdca6-demo-a8df-va86-e4bcc1ea52bc) is not ready, currently CREATING", "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac" }

URI GET /v5/{project_id}/vpn-connection 表1 参数说明 名称 类型 是否必选 说明 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 表2 请求Query参数列表 名称 类型 是否必选 描述 vgw_ip String 否 VPN网关EIP的ID或接入私网IP。 vgw_id String 否 VPN网关ID。 enterprise_project_id Array 否 企业项目ID。 limit Integer 否 功能说明：分页查询时每页返回的记录数量。 取值范围：0-200。 默认值：200。 marker String 否 功能说明：查询本页的起始标记位，为空时为查询第一页。查询下一页的marker可以根据上一页响应的page_info对象中的next_marker填写。 约束：必须与limit一起使用。

请求消息 请求参数 无。 请求样例 查询所有VPN连接。 GET https://{Endpoint}/v5/{project_id}/vpn-connection 指定vgw_ip查询VPN连接。 GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_ip={vgw_ip}&limit={limit}&marker={marker} 指定VPN网关实例查询VPN连接。 GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_id={vgw_id}&limit={limit}&marker={marker}

响应消息 响应参数 返回状态码为 200: successful operation。 表3 响应Body参数列表 名称 类型 描述 vpn_connections Array of ResponseVpnConnection objects vpn_connection对象。 page_info PageInfo object 分页信息。 request_id String 请求ID。 total_count Long 租户下连接总数。 表4 ResponseVpnConnection 名称 类型 描述 id String 功能说明：VPN连接ID。 格式：36位UUID。 name String 功能说明：VPN连接名称，不填时会自动生成。 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线）、.（点）。 status String 功能说明：VPN连接状态。 取值范围： ERROR：异常。 ACTIVE：正常。 DOWN：未连接。 PENDING_CREATE：创建中。 PENDING_UPDATE：更新中。 PENDING_DELETE：删除中。 FREEZED：冻结中。 UNKNOWN：未知。 vgw_id String 功能说明：VPN网关ID。 格式：36位UUID。 vgw_ip String 功能说明： VPN网关EIP的ID或接入私网IP。 格式：36位UUID或点分十进制IPv4地址（如192.168.45.7）。 style String 功能说明：连接模式。 取值范围： POLICY: 策略模式。 STATIC: 静态路由模式。 BGP: bgp路由模式。 POLICY-TEMPLATE: 策略模板模式。 cgw_id String 功能说明：对端网关ID。 格式：36位UUID。 peer_subnets Array of String 对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY时不返回。 tunnel_local_address String 路由模式下配置在VPN网关上的tunnel接口地址。仅当style为STATIC或BGP时有效。 tunnel_peer_address String 路由模式下配置在用户侧设备上的tunnel接口地址。仅当style为STATIC或BGP时有效。 enable_nqa Boolean 功能说明：开启NQA检测。仅当style为STATIC时返回。 取值范围：true，false。 policy_rules Array of PolicyRule objects 策略模式的策略规则组。仅当style为POLICY时返回实际的策略规则组。 ikepolicy IkePolicy object ike策略对象。 ipsecpolicy IpsecPolicy object ipsec策略对象。 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。 enterprise_project_id String 功能说明：企业项目ID。 格式：36位UUID。与vgw_id所标识VPN网关的企业项目ID一致。 connection_monitor_id String 功能说明：VPN连接监控ID。仅当VPN连接下创建有连接监控时返回。 格式：36位UUID。 ha_role String 功能说明：主备模式VPN网关下的连接时，'master'表示主连接，'slave'表示备连接。双活模式下的连接ha_role都是'master'。 默认值：master。 tags Array of VpnResourceTag objects 标签列表。 表5 PolicyRule 名称 类型 描述 rule_index Integer 功能说明：规则ID。 取值范围：0-50。 source String 源地址网段。 destination Array of String 目的地址网段。单个网段格式示例：192.168.52.0/24。每个PolicyRule最多返回50个。 表6 IkePolicy 名称 类型 描述 ike_version String 功能说明：IKE版本号。 取值范围：v1, v2。 phase1_negotiation_mode String 功能说明：协商模式。仅当IKE版本为v1时返回。 取值范围： main：主模式，协商过程安全性高。 aggressive：野蛮模式，协商快速且协商成功率高。 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256，sha1，md5，sm3。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128，3des，sm4。 dh_group String 功能说明：第一阶段密钥交换使用的DH组，当VPN网关flavor为GM时不返回。 取值范围：group1，group2，group5，group14，group15，group16，group19，group20，group21。 authentication_method String 功能说明：ike协商时的认证方法。 取值范围： pre-share：预共享密钥。 digital-envelope-v2：国密数字信封。 lifetime_seconds Integer 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 取值范围：60-604800，单位：秒。 local_id_type String 功能说明：本端ID类型，当VPN网关flavor为GM时不返回。 取值范围：ip，fqdn。 local_id String 本端ID。当local_id_type为ip时返回VPN连接所使用的网关IP；当local_id_type为fqdn时返回创建或更新VPN连接时指定的本端ID。 当VPN网关flavor为GM时不返回。 peer_id_type String 功能说明：对端ID类型，当VPN网关flavor为GM时不返回。 取值范围：ip，fqdn。 peer_id String 对端ID。当peer_id_type为ip时返回对端网关的IP；当peer_id_type为fqdn时返回创建或更新VPN连接时指定的对端ID。 当VPN网关flavor为GM时不返回。 dpd Dpd object 对等体存活检测对象。 表7 Dpd 名称 类型 描述 timeout Integer 功能说明：对等体存活检测报文重传间隔。 取值范围：2-60，单位：秒。 interval Integer 功能说明：对等体存活检测空闲时间。 取值范围：10-3600，单位：秒。 msg String 功能说明：对等体存活检测报文格式。 取值范围： seq-hash-notify：指定DPD报文中的载荷顺序是hash-notify。 seq-notify-hash：指定DPD报文中的载荷顺序是notify-hash。 表8 IpsecPolicy 名称 类型 描述 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256，sha1，md5，sm3。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128，3des，sm4。 pfs String 功能说明：PFS使用的DH密钥组，当VPN网关flavor为GM时不返回。 取值范围：group1，group2，group5，group14，group15，group16，group19，group20，group21，disable。 transform_protocol String 功能说明：传输协议。 取值范围： esp：封装安全协议。 lifetime_seconds Integer 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 取值范围：30-604800，单位：秒。 encapsulation_mode String 功能说明：报文封装模式。 取值范围： tunnel：隧道模式。 表9 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 表10 PageInfo 名称 类型 描述 next_marker String 下一页的marker，值为上一次查询响应中最后一个资源的创建时间。 current_count Integer 当前列表中资源数量。若小于查询请求传入的limit则表示最后一页。 响应样例 查询所有VPN连接的响应。 { "vpn_connections": [{ "id": "228a68f0-demo-a8df-va86-a9919a3ea3de", "name": "vpn-56ea", "status": "DOWN", "vgw_id": "ba90819b-demo-a8df-va86-3a01622856a5", "vgw_ip": "3ea3b006-demo-a8df-va86-ae180ae07885", "style": "STATIC", "cgw_id": "537d9c26-demo-a8df-va86-99364a410f00", "peer_subnets": [ "192.168.1.0/24" ], "tunnel_local_address": "169.254.149.2/30", "tunnel_peer_address": "169.254.149.1/30", "enable_nqa": true, "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 86400, "local_id_type": "ip", "local_id": "10.1.1.216", "peer_id_type": "ip", "peer_id": "10.0.1.67", "dpd": { "timeout": 15, "interval": 30, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-12-11T13:59:59.633Z", "updated_at": "2022-12-11T13:59:59.633Z", "enterprise_project_id": "0" }, { "id": "a4df33ca-demo-a8df-va86-410a7dd6973f", "name": "vpn-15ea", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "POLICY", "cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33", "tunnel_local_address": "169.254.77.169/30", "tunnel_peer_address": "169.254.77.170/30", "policy_rules": [{ "rule_index": 1, "source": "10.0.0.0/24", "destination": [ "192.168.44.0/24" ] }], "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 3600, "local_id_type": "ip", "local_id": "88.88.201.167", "peer_id_type": "ip", "peer_id": "10.111.222.21", "dpd": { "interval": 30, "timeout": 15, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-12-09T07:24:27.674Z", "updated_at": "2022-12-09T07:24:27.674Z", "enterprise_project_id": "0", "ha_role":"master" } ], "page_info": { "next_marker": "2022-12-09T07:24:27.674Z", "current_count": 2 }, "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac", "total_count": 2 } 指定vgw_ip查询VPN连接的响应。 { "vpn_connections": [ { "id": "8fa335dd-demo-a8df-va86-78bb55a8bb04", "name": "vpn-2acd", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "STATIC", "cgw_id": "eba04567-demo-a8df-va86-5b0352f89af0", "peer_subnets": [ "192.168.44.0/24" ], "tunnel_local_address": "169.254.58.225/30", "tunnel_peer_address": "169.254.58.226/30", "enable_nqa": false, "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 3600, "local_id_type": "ip", "local_id": "88.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.9", "dpd": { "timeout": 15, "interval": 30, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-12-11T14:24:25.115Z", "updated_at": "2022-12-11T14:24:25.115Z", "enterprise_project_id": "0" }, { "id": "a4df33ca-demo-a8df-va86-410a7dd6973f", "name": "vpn-15ea", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "POLICY", "cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33", "tunnel_local_address": "169.254.77.169/30", "tunnel_peer_address": "169.254.77.170/30", "policy_rules": [ { "rule_index": 1, "source": "10.0.0.0/24", "destination": [ "192.168.44.0/24" ] } ], "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 3600, "local_id_type": "ip", "local_id": "88.88.201.167", "peer_id_type": "ip", "peer_id": "10.111.222.21", "dpd": { "interval": 30, "timeout": 15, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-12-11T13:59:59.633Z", "updated_at": "2022-12-11T13:59:59.633Z", "enterprise_project_id": "0", "ha_role":"master" } ], "page_info": { "next_marker": "2022-12-11T13:59:59.633Z", "current_count": 2 }, "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac", "total_count": 12 } 指定VPN网关实例查询VPN连接的响应。 { "vpn_connections": [ { "id": "8fa335dd-demo-a8df-va86-78bb55a8bb04", "name": "vpn-2acd", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "STATIC", "cgw_id": "eba04567-demo-a8df-va86-5b0352f89af0", "peer_subnets": [ "192.168.44.0/24" ], "tunnel_local_address": "169.254.58.225/30", "tunnel_peer_address": "169.254.58.226/30", "enable_nqa": false, "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 3600, "local_id_type": "ip", "local_id": "88.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.9", "dpd": { "timeout": 15, "interval": 30, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-12-11T14:24:25.115Z", "updated_at": "2022-12-11T14:24:25.115Z", "enterprise_project_id": "0", "ha_role":"master" }, { "id": "a4df33ca-demo-a8df-va86-410a7dd6973f", "name": "vpn-15ea", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "POLICY", "cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33", "tunnel_local_address": "169.254.77.169/30", "tunnel_peer_address": "169.254.77.170/30", "policy_rules": [ { "rule_index": 1, "source": "10.0.0.0/24", "destination": [ "192.168.44.0/24" ] } ], "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 3600, "local_id_type": "ip", "local_id": "88.88.201.167", "peer_id_type": "ip", "peer_id": "10.111.222.21", "dpd": { "interval": 30, "timeout": 15, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-12-11T13:59:59.633Z", "updated_at": "2022-12-11T13:59:59.633Z", "enterprise_project_id": "0", "ha_role":"master" } ], "page_info": { "next_marker": "2022-12-11T13:59:59.633Z", "current_count": 2 }, "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac", "total_count": 12 }

响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 vpn_gateway ResponseVpnGateway object vpn_gateway对象。 request_id String 请求ID。 表3 ResponseVpnGateway 名称 类型 描述 id String 功能说明：VPN网关ID。 格式：36位UUID。 name String 功能说明：VPN网关名称，不填时会自动生成。 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线）、.（点）。 network_type String 功能说明：VPN网关网络类型。 取值范围：public，private。 默认值：public。 status String 功能说明：VPN网关状态。 取值范围： PENDING_CREATE：创建中。 PENDING_UPDATE：更新中。 PENDING_DELETE：删除中。 ACTIVE：正常。 FAULT：异常。 FREEZED：冻结。 attachment_type String 功能说明：关联模式。 取值范围：vpc，er。 certificate_id String 功能说明：证书ID。 格式：36位UUID。 er_id String VPN网关所连接的ER实例的ID。仅当attachment_type为er时返回。 vpc_id String VPN网关关联的业务VPC的ID。仅当attachment_type为vpc时返回。 local_subnets Array of String 本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：192.168.52.0/24。仅当attachment_type为vpc时返回。 connect_subnet String VPN网关所使用的VPC中的一个子网ID。 bgp_asn Long VPN网关的BGP自治域编号。 flavor String 功能说明：VPN网关的规格类型。 取值范围： Basic：最大转发带宽100Mbps。 Professional1：最大转发带宽300Mbps。 Professional1-NonFixedIP：最大转发带宽300Mbps。 Professional2：最大转发带宽1Gbps。 Professional2-NonFixedIP：最大转发带宽1Gbps。 GM：最大转发带宽500Mbps。 availability_zone_ids Array of String 部署VPN网关的可用区。当指定了可用区时则返回；当未指定可用区时，在VPN网关的状态为ACTIVE时返回。 connection_number Integer VPN网关下的最大VPN连接数。 used_connection_number Integer VPN网关下当前已经使用的VPN连接数。 used_connection_group Integer VPN网关下当前已经使用的VPN连接组个数。同一用户网关入云的两条连接组成一个连接组。VPN网关默认支持10个免费的VPN连接组。 enterprise_project_id String 功能说明：企业项目ID。 格式：36位UUID。创建时不传则返回"0"，表示资源属于default企业项目。 注："0"并不是真实存在的企业项目ID。 eip1 ResponseEip object 双活VPN网关表示使用的第一个EIP，主备模式VPN网关表示主EIP。在VPN网关的状态为ACTIVE时返回。 eip2 ResponseEip object 双活VPN网关表示使用的第二个EIP，主备模式VPN网关表示备EIP。在VPN网关的状态为ACTIVE时返回。 created_at String 创建时间。在VPN网关的状态为ACTIVE时返回。 UTC时间格式：yyyy-MM-ddTHH:mm:ss。 非UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。 updated_at String 最后一次更新时间。在VPN网关的状态为ACTIVE时返回。 UTC时间格式：yyyy-MM-ddTHH:mm:ss。 非UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。 access_vpc_id String 功能说明：VPN网关使用的接入VPC ID。 格式：36位UUID。 access_subnet_id String 功能说明：VPN网关使用的接入VPC中的子网ID。 格式：36位UUID。 access_private_ip_1 String 私网类型VPN网关的接入私网IP，VPN网关使用该私网IP与对端网关建连。双活网关表示使用的第一个私网地址，主备表示主私网地址。 示例：192.168.52.9。仅当network_type为private时返回。 access_private_ip_2 String 私网类型VPN网关的接入私网IP，VPN网关使用该私网IP与对端网关建连。双活网关表示使用的第二个私网地址，主备表示备私网地址。 示例：192.168.52.9。仅当network_type为private时返回。 certificate_id String 功能说明：VPN网关使用的VPN网关证书ID，仅在flavor为GM时返回。 格式：36位UUID ha_mode String 功能说明：网关的HA模式，"active-active"表示双活，"active-standby"表示主备。 取值范围：active-active，active-standby。 默认值：active-active。 policy_template PolicyTemplate object 非固定IP接入VPN网关网关的策略模板配置，只有在规格为非固定IP接入VPN网关时返回。 supported_flavors Array of String 网关可升配到的目标规格。 tags Array of VpnResourceTag objects 标签列表。 表4 ResponseEip 名称 类型 描述 id String 功能说明：EIP的ID。 格式：36位UUID。当使用默认企业项目时返回"0"。 ip_version Integer 功能说明：EIP版本。 取值范围：4。 ip_billing_info String 功能说明：EIP的订单信息。包年/包月EIP才会返回订单信息，按需计费的EIP不返回。 格式：order_id:product_id:region_id:project_id，如： CS22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa。 type String 功能说明：EIP的类型。 取值范围：可查看申请EIP表6中type字段的取值范围。 ip_address String 功能说明：EIP的公网IPv4地址。 格式：ipv4类型地址。例如：88.***.***.11。 charge_mode String 功能说明：EIP的带宽计费模式。按流量计费或按带宽计费。 取值范围： bandwidth：按带宽计费。 traffic：按流量计费。 bandwidth_id String 功能说明：EIP的带宽ID。 格式：36位UUID。 bandwidth_size Integer 功能说明：EIP的带宽大小，单位：Mbit/s。每个region能够提供的EIP最大带宽不同，EIP的最大带宽受限于EIP服务，可以使用工单来提高账户下的EIP的最大带宽。 取值范围：1-1000。 bandwidth_name String 功能说明：EIP的带宽名称。 取值范围：1-64个字符，支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。 bandwidth_billing_info String 功能说明：EIP的带宽订单信息。包年/包月EIP带宽才会返回带宽订单信息，按需计费的EIP带宽不返回。 格式：order_id:product_id:region_id:project_id，如： CS22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa。 表5 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike 策略对象。 ipsec_policy IpsecPolicy object ipsec 策略对象。 表6 IkePolicy 名称 类型 描述 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 dh_group String 功能说明：第一阶段密钥交换使用的DH组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 lifetime_seconds Integer 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 取值范围：60-604800，单位：秒。 表7 IpsecPolicy 名称 类型 描述 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 pfs String 功能说明：PFS使用的DH密钥组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 lifetime_seconds Integer 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 取值范围：30-604800，单位：秒。 表8 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 响应样例 查询公网类型关联ER的VPN网关。 { "vpn_gateway": { "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5", "name": "vpngw-5bd6", "network_type": "public", "status": "ACTIVE", "attachment_type": "er", "er_id": "c62fad0d-demo-a8df-va86-e06c4c351b9f", "bgp_asn": 64512, "flavor": "Professional1", "availability_zone_ids": ["cn-south-1f", "cn-south-1e"], "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "eip1": { "id": "0f6d1415-demo-a8df-va86-edb2ee97c9cc", "ip_version": 4, "type": "5_bgp", "ip_address": "88.***.***.251", "charge_mode": "bandwidth", "bandwidth_id": "e93767cc-demo-a8df-va86-bac2987f90a4", "bandwidth_size": 300, "bandwidth_name": "vpngw-bandwidth-10c3" }, "eip2": { "id": "7b46b62f-demo-a8df-va86-6b8e44312416", "ip_version": 4, "type": "5_bgp", "ip_address": "88.***.***.102", "charge_mode": "bandwidth", "bandwidth_id": "bde3557e-demo-a8df-va86-629a3754ae07", "bandwidth_size": 300, "bandwidth_name": "vpngw-bandwidth-18bd" }, "created_at": "2022-11-28T02:22:27.24Z", "updated_at": "2022-11-28T02:22:27.24Z", "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799" } 查询私网类型关联VPC的VPN网关。 { "vpn_gateway": { "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5", "name": "vpngw-5bd6", "network_type": "private", "status": "ACTIVE", "attachment_type": "vpc", "vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c", "local_subnets": ["192.168.0.0/24"], "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "bgp_asn": 64512, "flavor": "Professional1", "availability_zone_ids": ["cn-south-1f", "cn-south-1e"], "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "created_at": "2022-11-28T02:22:27.24Z", "updated_at": "2022-11-28T02:22:27.24Z", "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "access_private_ip_1": "192.168.146.45", "access_private_ip_2": "192.168.146.77", "ha_mode": "active-active" }, "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799" } 查询公网类型关联VPC的非固定IP接入VPN网关。 { "vpn_gateway":{ "id":"66ddeacb-demo-a8df-va86-9a414b5bd7d5", "name":"vpngw-5bd6", "network_type":"public", "status":"ACTIVE", "attachment_type":"vpc", "vpc_id":"c62fad0d-demo-a8df-va86-e06c4c351b9f", "local_subnets":[ "192.168.0.0/24" ], "connect_subnet":"fd75bf7b-demo-a8df-va86-db13f03e299a", "bgp_asn":64512, "flavor":"Professional1-NonFixedIP", "availability_zone_ids":[ "cn-north-7c" ], "connection_number":200, "used_connection_number":0, "used_connection_group":0, "enterprise_project_id":"0", "ha_mode":"active-standby", "eip1":{ "id":"0f6d1415-demo-a8df-va86-edb2ee97c9cc", "ip_version":4, "type":"5_bgp", "ip_address":"88.***.***.251", "charge_mode":"bandwidth", "bandwidth_id":"e93767cc-demo-a8df-va86-bac2987f90a4", "bandwidth_size":300, "bandwidth_name":"vpngw-bandwidth-10c3" }, "eip2":{ "id":"7b46b62f-demo-a8df-va86-6b8e44312416", "ip_version":4, "type":"5_bgp", "ip_address":"88.***.***.102", "charge_mode":"bandwidth", "bandwidth_id":"bde3557e-demo-a8df-va86-629a3754ae07", "bandwidth_size":300, "bandwidth_name":"vpngw-bandwidth-18bd" }, "policy_template":{ "ike_policy":{ "encryption_algorithm":"aes-128", "dh_group":"group20", "authentication_algorithm":"sha2-256", "lifetime_seconds":86400 }, "ipsec_policy":{ "authentication_algorithm":"sha2-256", "encryption_algorithm":"aes-128", "pfs":"group20", "lifetime_seconds":3600 } }, "created_at":"2022-11-28T02:22:27.24Z", "updated_at":"2022-11-28T02:22:27.24Z", "access_vpc_id":"4d03fe2d--demo-a8df-va86-6def96440f2b", "access_subnet_id":"fd75bf7b--demo-a8df-va86-e-db13f03e299a" }, "request_id":"28b795f8-d431-4f1e-93ab-1c401a82b799" }

修订记录 表1 修订记录 发布日期 更新说明 2024-04-19 第五次正式发布。文档内容更新为： 修改创建VPN网关章节，“flavor”参数新增VPN网关规格的描述说明。 2023-12-30 第四次正式发布。文档内容更新为： 新增标签章节。 修改创建VPN网关、查询VPN网关、查询VPN网关列表、更新VPN网关、创建对端网关、查询对端网关、查询对端网关列表、更新对端网关、创建VPN连接、查询VPN连接、查询VPN连接列表、更新VPN连接章节，新增“tags”参数。 修改创建VPN网关、查询VPN网关、查询VPN网关列表章节，删除“master_eip”、“slave_eip”参数。 修改更新VPN网关章节，删除“master_eip_id”、“slave_eip_id”参数。 修改查询VPN网关、查询VPN网关列表章节，删除“access_private_ips”参数。 2023-09-30 第三次正式发布。文档内容更新为： 修改查询VPN网关、查询VPN网关列表、更新VPN网关章节，“flavor”参数新增非固定IP接入的VPN网关规格的描述说明。 修改查询VPN网关可用区章节，响应消息中新增“professional1-NonFixedIP”“professional2-NonFixedIP”参数，修改响应样例。 修改查询VPN网关、查询VPN网关列表、更新VPN网关章节，新增非固定IP接入特性的相关描述说明。 2023-07-15 第二次正式发布。文档内容更新为： 新增上传VPN网关证书章节。 新增查询VPN网关证书详情章节。 新增更新VPN网关证书章节。 修改创建VPN网关、查询VPN网关、查询VPN网关列表、更新VPN网关章节，“flavor”参数新增国密特性的描述说明。 修改查询VPN网关、创建对端网关、查询对端网关、查询对端网关列表、更新对端网关章节，新增“certificate_id”参数。 修改查询VPN网关可用区章节，响应消息中新增“GM”参数，修改响应样例。 修改创建VPN连接、查询VPN连接、查询VPN连接列表、更新VPN连接章节，新增国密特性相关的描述说明。 修改创建VPN网关章节，修改“bandwidth_size”参数的描述说明。 修改创建VPN连接章节，修改“dh_group”和“pfs”参数的默认值为“group15”。 修改创建VPN网关、查询VPN网关、查询VPN网关列表、更新VPN网关章节，新增“ha_mode”、“eip1”、“eip2”参数，修改“master_eip”、“slave_eip”参数的描述说明。 修改查询VPN网关、查询VPN网关列表和更新VPN网关章节，新增“access_private_ip_1”、“access_private_ip_2”，修改“access_private_ips”参数的描述说明。 修改创建VPN连接、查询VPN连接、查询VPN连接列表、更新VPN连接章节，新增“ha_role”参数。 2022-12-31 第一次正式发布。

请求消息 请求参数 表3 请求参数 名称 类型 是否必选 描述 without_any_tag Boolean 否 功能说明：该字段为true时查询所有不带标签的资源，此时忽略 “tags”字段。该字段为false或者未提供该参数时，该条件不生效，即返回所有资源或按"tags"，"matches"等条件过滤。 tags Array of Tag objects 否 功能说明：标签列表。 约束：最多填写20个。 matches Array of Match objects 否 功能说明：搜索字段，包含key和value。key为要匹配的字段，如resource_name等。value为匹配的值。key为固定字典值。 表4 Tag 名称 类型 是否必选 描述 key String 是 功能说明：标签的键。 取值范围：1-128个字符。 values Array of String 是 功能说明：标签的值列表。如果values为空列表，则表示any_value。value之间为或的关系。 取值范围：0-255个字符。 约束：最多填写20个。 表5 Match 名称 类型 是否必选 描述 key String 是 功能说明：匹配的键。 取值范围：resource_name。 value String 是 功能说明：匹配的值。 取值范围：0-255个字符。 请求样例 POST https://{Endpoint}/v5/{project_id}/{resource_type}/resource-instances/filter { "tags": [{ "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [{ "key": "resource_name", "value": "resource1" }], "without_any_tag": "false" }

响应消息 响应参数 返回状态码为 200: 查询成功。 表6 响应Body参数列表 名称 类型 描述 resources Array of Resource objects 资源对象列表。 total_count Integer 总记录数。 表7 Resource 名称 类型 描述 resource_id String 资源ID。 resource_detail object 资源详情。用于扩展，默认为空。 tags Array of ResourceTag objects 标签列表。 resource_name String 资源名称。 表8 ResourceTag 名称 类型 描述 key String 标签的键。 value String 标签的值。 响应样例 { "resources": [{ "resource_id": "134f9fb1-demo-a8df-va86-2040a5c13325", "resource_name": "resouece1", "tags": [{ "key": "key1", "value": "value1" }] }], "total_count": 1000 }

URI POST /v5/{project_id}/{resource_type}/resource-instances/filter 表1 参数说明 名称 类型 是否必选 说明 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 resource_type String 是 功能说明：资源类型。 取值范围：vpn-gateway，customer-gateway，vpn-connection。 表2 请求Query参数列表 名称 类型 是否必选 描述 limit Integer 否 功能说明：查询记录数。 取值范围：1-1000。 默认值：1000。 offset Integer 否 功能说明：索引位置。从第offset条数据的下一条数据开始查询。 取值范围：最小值为0。 默认值：0。

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 模块 状态码 错误码 错误信息 描述 处理措施 公共 400 VPN.0001 invalid request:xxx 输入参数不合法 联系技术支持。 500 VPN.0002 server error: xxx 服务器内部错误 联系技术支持。 403 VPN.0003 Authentication failed: xxx 拒绝访问 请赋予正确的细粒度权限。 404 VPN.0004 resource not found 资源未找到 请确认资源的id是否填写正确或该租户下是否确实存在该资源。

响应消息 响应参数 返回状态码为200: successful operation。 表4 响应Body参数列表 名称 类型 描述 certificate VpnGatewayCertificateConfig object VPN网关证书对象。 request_id String 请求id。 表5 VpnGatewayCertificateConfig 名称 类型 描述 id String 功能说明：VPN网关证书ID。 格式：36位UUID。 name String 功能说明：VPN网关证书名称。 取值范围：3-63个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 vgw_id String 功能说明：VPN网关ID。 格式：36位UUID。 issuer String 功能说明：国密签名证书颁发者。 取值范围：1-256个字符。 signature_algorithm String 功能说明：国密签名证书签名算法。 取值范围：1-64个字符。 certificate_serial_number String 功能说明：国密签名证书序列号。 取值范围：1-64个字符。 certificate_subject String 功能说明：国密签名证书使用者。 取值范围：1-256个字符。 certificate_expire_time String 国密签名证书过期时间。 certificate_chain_serial_number String 功能说明：国密CA证书序列号。 取值范围：1-64个字符。 certificate_chain_subject String 功能说明：国密CA证书使用者。 取值范围：1-256个字符。 certificate_chain_expire_time String 功能说明：国密CA证书过期时间。 enc_certificate_serial_number String 功能说明：国密加密证书序列号。 取值范围：1-64个字符。 enc_certificate_subject String 功能说明：国密加密证书使用者。 取值范围：1-256个字符。 enc_certificate_expire_time String 功能说明：国密加密证书过期时间。 created_at String 功能说明：创建时间。 响应样例 { "certificate": { "id": "73f072d8-demo-a8df-va86-2a755d95636f", "name": "cert-dce7", "vgw_id": "c7f1d3e3-0476-4a71-95a7-3ce8cbb969de", "issuer": "C=CN,ST=Beijing,L=HaiDian,O=GMCert.org,CN=GMCert GM Root CA - 01", "signature_algorithm": "SM3WITHSM2", "certificate_serial_number": "16548506527294397241", "certificate_subject": "C=CN,ST=beijing,L=beijing,O=huawei,OU=vpn,CN=hwcloud-vpn", "certificate_expire_time": "2024-02-20T15:41:39+08:00", "certificate_chain_serial_number": "12369133709000538078", "certificate_chain_subject": "C=CN,ST=Beijing,L=HaiDian,O=GMCert.org,CN=GMCert GM Root CA - 01", "certificate_chain_expire_time": "2039-07-11T20:31:33+08:00", "enc_certificate_serial_number": "16548506527294397242", "enc_certificate_subject": "C=CN,ST=beijing,L=beijing,O=huawei,OU=vpn,CN=hwcloud-vpn", "enc_certificate_expire_time": "2024-02-20T15:43:26+08:00", "created_at": "2023-03-30T10:47:16.657+08:00" } }

请求消息 请求参数 表2 UpdateVpnGatewayCertificateRequestBody 名称 类型 是否必选 描述 certificate UpdateVpnGatewayCertificateRequestBodyContent object 是 VPN网关证书对象。 表3 UpdateVpnGatewayCertificateRequestBodyContent 名称 类型 是否必选 描述 name String 否 功能说明：VPN网关证书名称。 取值范围：3-63个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(英文句点)。 certificate String 否 功能说明：国密签名证书内容,如果只更新证书名称可以不传。 取值范围：1-4096个字符。 private_key String 否 功能说明：国密签名证书私钥，如果只更新证书名称可以不传。 取值范围：1-4096个字符。 certificate_chain String 否 功能说明：CA证书内容，如果只更新证书名称可以不传。 取值范围：1-8192个字符。 enc_certificate String 否 功能说明：国密加密证书内容，如果只更新证书名称可以不传。 取值范围：1-4096个字符。 enc_private_key String 否 功能说明：国密加密证书私钥，如果只更新证书名称可以不传。 取值范围：1-4096个字符。 请求样例 POST https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}/certificate/{certificate_id} { "certificate": { "name": "cert-dce7", "certificate": "-----BEGIN CERTIFICATE-----******-----END CERTIFICATE-----", "private_key": "-----BEGIN EC PRIVATE KEY-----*******-----END EC PRIVATE KEY-----", "enc_certificate": "-----BEGIN CERTIFICATE-----********-----END CERTIFICATE-----", "enc_private_key": "-----BEGIN EC PRIVATE KEY-----********-----END EC PRIVATE KEY-----", "certificate_chain": "-----BEGIN CERTIFICATE-----******-----END CERTIFICATE-----" } }

响应消息 响应参数 返回状态码为 201: successful operation。 表6 响应Body参数列表 名称 类型 描述 vpn_gateway ResponseVpnGateway object VPN网关对象。 request_id String 请求ID。 表7 ResponseVpnGateway 名称 类型 描述 id String 功能说明：VPN网关ID。 格式：36位UUID。 nam String 功能说明：VPN网关名称，不填时会自动生成。 取值范围：1-64个字符，包括数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 network_typ String 功能说明：VPN网关网络类型。 取值范围：public，private。 默认值：public。 attachment_type String 功能说明：关联模式。 取值范围：vpc，er。 certificate_id String 功能说明：证书ID。 格式：36位UUID。 er_id String VPN网关所连接的ER实例的ID。仅当attachment_type为er时返回。 vpc_id String 当attachment_type为vpc时，vpc_id是VPN网关关联的业务VPC的ID。 当attachment_type为er时，vpc_id是VPN网关的接入VPC的ID。 local_subnets Array of String 本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：192.168.52.0/24。仅当attachment_type为vpc时返回。 connect_subnet String VPN网关所使用的VPC中的一个子网ID。 bgp_asn Long VPN网关的BGP自治域编号。 flavor String 功能说明：VPN网关的规格类型。 取值范围： Basic：最大转发带宽100Mbps。 Professional1：最大转发带宽300Mbps。 Professional1-NonFixedIP：最大转发带宽300Mbps。 Professional2：最大转发带宽1Gbps。 Professional2-NonFixedIP：最大转发带宽1Gbps。 GM: 最大转发带宽500Mbps。 connection_number Integer VPN网关下的最大VPN连接数。 used_connection_number Integer VPN网关下当前已经使用的VPN连接数。 used_connection_group Integer VPN网关下当前已经使用的VPN连接组个数。同一用户网关入云的两条连接组成一个连接组。VPN网关默认支持10个免费的VPN连接组。 enterprise_project_id String 功能说明：企业项目ID。 格式：36位UUID或者"0"。 access_vpc_id String 功能说明：VPN网关使用的接入VPC ID。 格式：36位UUID。 access_subnet_id String 功能说明：VPN网关使用的接入VPC中的子网ID。 格式：36位UUID。 ha_mode String 功能说明：网关的HA模式，"active-active"表示双活，"active-standby"表示主备。 取值范围：active-active，active-standby。 默认值：active-active。 policy_template PolicyTemplate object 非固定IP接入VPN网关网关的策略模板配置，只有在规格为非固定IP接入VPN网关时返回。 tags Array of VpnResourceTag objects 标签列表。 表8 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 表9 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike 策略对象。 ipsec_policy IpsecPolicy object ipsec 策略对象。 表10 IkePolicy 名称 类型 描述 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 dh_group String 功能说明：第一阶段密钥交换使用的DH组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 lifetime_seconds Integer 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 取值范围：60-604800，单位：秒。 表11 IpsecPolicy 名称 类型 描述 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 pfs String 功能说明：PFS使用的DH密钥组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 lifetime_seconds Integer 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 取值范围：30-604800，单位：秒。 响应样例 使用已有EIP创建关联VPC的VPN网关的响应。 { "vpn_gateway": { "id": "134f9fb1-demo-a8df-va86-2040a5c13325", "name": "vpngw-9f24", "network_type": "public", "attachment_type": "vpc", "vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "local_subnets": ["192.168.0.0/24"], "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "bgp_asn": 64512, "flavor": "Professional1", "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "7b37532a-d6e4-46b9-98dc-9169ec2ca58f" } 新建EIP创建关联ER的VPN网关的响应。 { "vpn_gateway": { "id": "80ac167b-demo-a8df-va86-a9a2a23223b8", "name": "vpngw-1234", "network_type": "public", "attachment_type": "er", "er_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "bgp_asn": 65533, "flavor": "Professional2", "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "cd71cade-bfbd-410b-b672-4bfe46cfc311" } 创建私网关联VPC的VPN网关的响应。 { "vpn_gateway": { "id": "80ac167b-demo-a8df-va86-a9a2a23223b8", "name": "vpngw-1234", "network_type": "private", "attachment_type": "vpc", "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "local_subnets": ["192.168.0.0/24", "192.168.1.0/24"], "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "bgp_asn": 65533, "flavor": "Professional2", "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "access_vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "cd71cade-bfbd-410b-b672-4bfe46cfc311" }

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 vpn_gateway CreateVgwRequestBodyContent object 是 VPN网关对象。 表3 CreateVgwRequestBodyContent 名称 类型 是否必选 描述 name String 否 功能说明：VPN网关名称。 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线）、.（点）。 默认值：不填时会自动生成格式为vpngw-****的名称。例如：vpngw-a45b。 network_type String 否 功能说明：VPN网关网络类型，公网（public）类型的VPN网关通过EIP与对端网关建连；私网（private）类型的VPN网关通过VPC内的私网IP与对端网关建连。 取值范围：public，private。 默认值：public。 attachment_type String 否 功能说明：关联模式。 取值范围：vpc，er。 默认值：vpc。 er_id String 否 功能说明：VPN网关所连接的ER实例的ID。 约束：36位UUID。当attachment_type配置为"er"时填写，否则不填。 可以通过查询企业路由列表查看ER实例的ID。 vpc_id String 否 功能说明： 当attachment_type为vpc时，vpc_id是VPN网关关联的业务VPC的ID。 当attachment_type为er时，vpc_id是VPN网关的接入VPC的ID，此时可以使用任意VPC的ID。 约束：36位UUID。当attachment_type配置为"vpc"时必填；当attachment_type配置为"er"时可不填写，当vpc_id和access_vpc_id都填写时，access_vpc_id生效。 可以通过查询VPC列表查看VPC的ID。 local_subnets Array of String 否 功能说明：本端子网是云上子网，该子网需要通过VPN与云下对端子网进行互通。 每个VPN网关最多填写50个本端子网，单个子网格式示例：192.168.52.0/24。 约束：当attachment_type配置为"vpc"时必填，否则不填。 connect_subnet String 否 功能说明：VPN网关使用的VPC子网ID。 约束：36位UUID。 当attachment_type配置为"vpc"时必填；当attachment_type配置为"er"时可不填写，当connect_subnet和access_subnet_id都填写时，access_subnet_id生效。 当attachment_type为er时，子网中需要有至少2个空闲IP。 当attachment_type为vpc时，如果access_subnet_id与connect_subnet相同，则子网中需要有至少4个空闲IP；如果不同，则需要至少2个空闲IP。 bgp_asn Long 否 功能说明：VPN网关的BGP自治域编号。 取值范围：1-4294967295。 默认值：64512。 flavor String 否 功能说明：VPN网关的规格类型。 取值范围： Basic Professional1 Professional2 Professional1-NonFixedIP Professional2-NonFixedIP GM 不同规格类型的特性，请参考企业版VPN不同型号的区别。 华北-乌兰察布一：Basic、Professional1、Professional2、GM 华南-广州：Basic、Professional1、Professional2 华北-北京四：Basic、Professional1、Professional2 华东-上海一：Basic、Professional1、Professional2 西南-贵阳一：Basic、Professional1、Professional2 中国-香港：Professional1、Professional2 亚太-曼谷：Professional1、Professional2 亚太-新加坡：Professional1、Professional2 亚太-雅加达：Professional1、Professional2 欧洲-都柏林：Professional1、Professional2 中东-阿布扎比-OP5：Professional1、Professional2 拉美-墨西哥城二：Professional1、Professional2 土耳其-伊斯坦布尔：Professional1、Professional2 约束：当network_type为private时不能填写Basic；当attachment_type为er时不能填写Basic。 默认值：Professional1。 availability_zone_ids Array of String 否 功能说明：部署VPN网关的可用区。不填时自动为VPN网关选择可用区。如果需要指定可用区可以通过查询VPN网关可用区查询可用区列表。 约束：查询VPN网关可用区返回两个及以上可用区时必须填写2个；返回1个可用区时填写1个；返回无可用区时不能创建。 enterprise_project_id String 否 功能说明：企业项目ID。 约束：36位UUID或者"0"。 默认值："0"，表示资源属于default企业项目。 eip1 CreateRequestEip object 否 功能说明：双活VPN网关表示使用的第一个EIP，主备模式网关表示主EIP。 约束：network_type为public时必选，为private时不需要填写。 eip2 CreateRequestEip object 否 功能说明：双活VPN网关表示使用的第二个EIP，主备模式网关表示备EIP。 约束：network_type为public时必选，为private时不需要填写。 access_vpc_id String 否 功能说明：VPN网关使用的接入VPC ID。 约束：36位UUID。 默认值：同vpc_id字段所填的值。 可以通过查询VPC列表查看VPC的ID。 access_subnet_id String 否 功能说明：VPN网关使用的接入VPC中的子网ID。 约束：36位UUID。 当attachment_type为er时，子网中需要有至少2个空闲IP。 当attachment_type为vpc时，如果access_subnet_id与connect_subnet相同，则子网中需要有至少4个空闲IP；如果不同，则需要至少2个空闲IP。 默认值：同connect_subnet字段所填的值。 ha_mode String 否 功能说明：网关的HA模式，"active-active"表示双活，"active-standby"表示主备。 取值范围：active-active，active-standby。 默认值：active-active。 access_private_ip_1 String 否 功能说明：私网类型VPN网关的接入私网IP1，指定ip创建私网网关时设置，主备网关时为主ip，双活网关时为主ip1。 取值范围：接入子网网段内的可分配ip。 约束：需与接入ip2同时指定，不能与接入ip2重复。 access_private_ip_2 String 否 功能说明：私网类型VPN网关的接入私网IP2，指定ip创建私网网关时设置，主备网关时为备ip，双活网关时为主ip2。 取值范围：接入子网网段内的可分配ip。 约束：需与接入ip1同时指定，不能与接入ip1重复。 tags Array of VpnResourceTag objects 否 功能说明：标签列表。 约束：最多填写20个。 表4 CreateRequestEip 名称 类型 是否必选 描述 id String 否 功能说明：EIP的ID。 取值范围：36位UUID。 约束：当使用已有EIP时填写，当新创建EIP时不填。不能填写共享带宽类型的EIP的ID；不能填写已冻结的EIP的ID。 可以通过全量查询弹性公网IP列表查看EIP的ID。 type String 否 功能说明：EIP的类型。 取值范围：0-36个字符。 可查看申请EIP表6中type字段的取值范围。如果对应局点支持5_bgp类型，建议优先选择该类型。 约束：当新创建EIP场景时需要填写，否则不填。 具体约束可查看申请EIP表4中type字段的约束。 charge_mode String 否 功能说明：EIP的带宽计费模式。按流量计费或按带宽计费。 取值范围： bandwidth：按带宽计费。 traffic：按流量计费。 约束：当新创建EIP场景时需要填写，否则不填。 默认值：bandwidth。 bandwidth_size Integer 否 功能说明：EIP的带宽大小，单位：Mbit/s。每个region能够提供的EIP最大带宽不同，EIP的最大带宽受限于EIP服务，可以使用工单来提高账户下的EIP的最大带宽。 取值范围：1-1000，具体取值请参考弹性公网服务创建eip资料。 约束：当新创建EIP场景时需要填写，否则不填。 flavor为Basic时，取值不能大于100；flavor为Professional1时，取值不能大于300；flavor为Professional2时，取值不能大于1000；flavor为GM时，取值不能大于500。 bandwidth_name String 否 功能说明：EIP的带宽名称。 取值范围：1-64个字符，支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。 约束：当新创建EIP场景时需要填写，否则不填。 默认值：当新创建EIP场景时，不填此字段会自动生成格式为vpngw-bandwidth-****的EIP带宽名称。例如：vpngw-bandwidth-e1fa。 表5 VpnResourceTag 名称 类型 是否必选 描述 key String 是 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 是 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 请求样例 使用已有EIP创建关联VPC的VPN网关。 POST https://{Endpoint}/v5/{project_id}/vpn-gateways { "vpn_gateway": { "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "local_subnets": [ "192.168.0.0/24", "192.168.1.0/24" ], "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "eip1": { "id": "cff40e5e-demo-a8df-va86-7366077bf097" }, "eip2": { "id": "d290f1ee-demo-a8df-va86-d701748f0851" } } } 新建EIP创建关联ER的VPN网关。 POST https://{Endpoint}/v5/{project_id}/vpn-gateways { "vpn_gateway": { "name": "vpngw-1234", "attachment_type": "er", "er_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "vpc_id": "584a238f-demo-a8df-va86-edca746f6277", "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "bgp_asn": 65533, "flavor": "Professional2", "availability_zone_ids": [ "cn-south-1f", "cn-south-1e" ], "eip1": { "type": "5_bgp", "charge_mode": "bandwidth", "bandwidth_size": 1000, "bandwidth_name": "vpngw-bandwidth-1391" }, "eip2": { "type": "5_bgp", "charge_mode": "bandwidth", "bandwidth_size": 1000, "bandwidth_name": "vpngw-bandwidth-1392" } } } 创建私网关联VPC的VPN网关。 POST https://{Endpoint}/v5/{project_id}/vpn-gateways { "vpn_gateway": { "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "local_subnets": [ "192.168.0.0/24", "192.168.1.0/24" ], "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "network_type": "private" } }

权限及授权项说明 如果您需要对您所拥有的VPN资源进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），如果华为云帐号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用VPN服务的其它功能。 默认情况下，新建的IAM用户没有任何权限，您需要将其加入用户组，并给用户组授予策略或角色，才能使用户组中的用户获得相应的权限，这一过程称为授权。授权后，用户就可以基于已有权限对云服务进行操作。 权限根据授权的精细程度，分为角色和策略。角色以服务为粒度，是IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。策略以API接口为粒度进行权限拆分，授权更加精细，可以精确到某个操作、资源和条件，能够满足企业对权限最小化的安全管控要求。 如果您要允许或是禁止某个接口的操作权限，请使用策略。 帐号具备所有接口的调用权限，如果使用帐号下的IAM用户发起API请求时，该IAM用户必须具备调用该接口所需的权限，否则，API请求将调用失败。每个接口所需要的权限，与各个接口所对应的授权项相对应，只有发起请求的用户被授予授权项所对应的策略，该用户才能成功调用该接口。例如，用户要调用接口来查询VPN 网关列表，那么这个IAM用户被授予的策略中必须包含允许“vpn:vpnGateways:list”的授权项，该接口才能调用成功。 支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：策略实际调用的API接口。 授权项：策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 VPN的支持自定义策略授权项如下所示： 【示例】VPN网关，包含VPN 网关接口对应的授权项，如创建VPN 网关、查询VPN 网关、查询VPN 网关列表、更新VPN 网关、删除VPN 网关等接口。 父主题： 权限和授权项