华为云用户手册

请求消息 请求参数 表2 请求参数 名称 类型 必选 描述 client_ca_certificate client_ca_certificate object 是 客户端CA证书对象 表3 client_ca_certificate 名称 类型 必选 描述 name String 否 功能说明：证书名称。 取值范围：1-64个字符，支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线) 请求样例 PUT https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates/{client_ca_certificate_id} { "client_ca_certificate": { "name": "client_ca_update" } }

URI PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates/{client_ca_certificate_id} 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID vpn_server_id String 是 VPN服务端ID client_ca_certificate_id String 是 客户端CA证书ID

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 users Array of OpVpnUser objects 是 VPN用户列表 表3 OpVpnUser 名称 类型 是否必选 描述 id String 是 功能描述：VPN用户ID 格式：36位UUID 请求样例 POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/remove-users { "users": [ { "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d" } ] }

URI POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/remove-users 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID vpn_server_id String 是 VPN服务端ID group_id String 是 VPN用户组ID

响应消息 响应参数 返回状态码为 200: successful operation。 表4 响应Body参数列表 名称 类型 描述 access_policy VpnAccessPolicy object VPN访问策略对象 request_id String 请求ID 表5 VpnAccessPolicy 名称 类型 描述 id String 功能描述：访问策略ID 格式：36位UUID name String 访问策略名称 user_group_id String 功能描述：关联用户组ID 格式：36位UUID user_group_name String 关联用户组名称 description String 访问策略描述 dest_ip_cidrs Array of String 功能描述：目的IP网段列表 格式："点分十进制/掩码"格式，例如192.168.1.0/24 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 响应示例 { "access_policy": { "id": "36f3f232-9204-4774-be20-84cc94da8535", "name": "policy-001-update", "user_group_id": "efb92c43-c2e9-44c0-b2e5-5b980f0ca90a", "user_group_name": "用户组A", "description": "访问策略1-update", "dest_ip_cidrs": [ "192.168.12.0/24", "192.168.1.0/24" ], "created_at": "2024-06-14T08:59:45.598Z", "updated_at": "2024-06-14T09:01:59.539Z" }, "request_id": "2e4cc58a4ea5fe69f62d6d8943b5f99b" }

URI PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies/{policy_id} 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID vpn_server_id String 是 VPN服务端ID policy_id String 是 访问策略ID

请求消息 请求参数 表2 请求参数 名称 类型 必选 描述 access_policy UpdateVpnAccessPolicyRequestBodyContent object 是 更新访问策略请求体对象 表3 UpdateVpnAccessPolicyRequestBodyContent 名称 类型 必选 描述 name String 否 访问策略名称 user_group_id String 否 功能描述：关联用户组ID 格式：36位UUID description String 否 访问策略描述 dest_ip_cidrs Array of strings 否 功能描述：目的IP网段列表 格式："点分十进制/掩码"格式，例如192.168.1.0/24 约束： 至少有1个网段，至多10个网段 请求样例 PUT https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies/{policy_id} { "access_policy": { "name": "policy-001-update", "user_group_id": "efb92c43-c2e9-44c0-b2e5-5b980f0ca90a", "description": "访问策略1-update", "dest_ip_cidrs": [ "192.168.12.0/24", "192.168.1.0/24" ] } }

响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 p2c_vpn_gateway p2c_vpn_gateway object vpn_gateway对象 request_id String 请求ID 表3 p2c_vpn_gateway 名称 类型 描述 id String 功能说明：P2C VPN网关ID 格式：36位UUID name String 功能说明：P2C VPN网关名称 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线） status String 功能说明：P2C VPN网关状态 取值范围： PENDING_CREATE：创建中 PENDING_UPDATE：更新中 PENDING_DELETE：删除中 ACTIVE：正常 FAULT：异常 FROZEN：冻结 vpc_id String P2C VPN网关所连接的VPC的ID connect_subnet String P2C VPN网关所使用的VPC子网ID flavor String 功能说明：P2C VPN网关的规格类型 取值范围: Professional1：专业型1 availability_zone_ids Array of strings 可用区列表 eip ResponseEipInfo object 网关绑定的EIP信息 max_connection_number Integer 功能说明：最多支持同时在线的客户端连接数 取值范围：1~500 current_connection_number Integer 当前建连的客户端连接数 enterprise_project_id String 企业项目ID tags Array of VpnResourceTag objects 标签列表 order_id String 订单ID admin_state_up Boolean 功能说明：冻结状态 取值范围： true：未冻结 false：冻结 frozen_effect Integer 功能说明：冻结影响，标识该资源冻结后是否可以删除 取值范围： 0：未冻结 1：冻结可删除 2：冻结不可删除 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：最后一次更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 表4 ResponseEipInfo 名称 类型 描述 id String 功能说明：EIP的ID 格式：36位UUID ip_version Integer 功能说明：EIP版本 取值范围：4 ip_billing_info String 功能说明：EIP的订单信息。包年/包月EIP才会返回订单信息，按需计费的EIP不返回 格式：order_id:product_id:region_id:project_id，如： CS 22********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，具体取值请参考弹性公网服务创建EIP资料。 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 share_type String 功能说明: 带宽共享类型 取值范围： PER：独享带宽 表5 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持任意语种字母、数字、空格和_.:=+-@，但首尾不能含有空格，不能以_sys_开头。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持任意语种字母、数字、空格和_.:/=+-@。 响应样例 { "p2c_vpn_gateway": { "id": "6d526e5f-a0c6-44b6-a785-000000000000", "name": "p2c-vpngw-0000", "status": "ACTIVE", "vpc_id": "05b9d7de-9acd-4a05-b497-1a3c75afaa0a", "connect_subnet": "1948ce22-ddc5-4fb6-87b8-dfcc9b176b51", "flavor": "Professional1", "availability_zone_ids": [ "cn-south-1f", "cn-south-1e" ], "eip": { "id": "f0bac06a-88a7-4d37-8e2e-c37691ee4ba2", "ip_version": 4, "ip_billing_info": "CS*********JWT1O:OFFI*************5078:cn-south-1:47190474************98781092d16c", "type": "5_youxuanbgp", "ip_address": "215.***.***.120", "charge_mode": "bandwidth", "bandwidth_id": "3456471c-9dac-40f6-8344-daca14fbd81e", "bandwidth_size": 20, "bandwidth_name": "p2c-vpngw-bandwidth-bd61", "bandwidth_billing_info": "CS*********JWT1O:OFFI*************5078:cn-south-1:47190474************98781092d16c", "share_type": "PER" }, "max_connection_number": 10, "current_connection_number": 0, "enterprise_project_id": "0", "tags": [], "order_id": "CS**********JWT1O", "admin_state_up": true, "frozen_effect": 0, "created_at": "2024-06-14T10:24:12.147Z", "updated_at": "2024-06-14T10:24:12.147Z" }, "request_id": "2ddd2f6107a8164ce6f6268bd991e57c" }

URI GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates/{client_ca_certificate_id} 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 vpn_server_id String 是 VPN服务端ID client_ca_certificate_id String 是 客户端CA证书ID

响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 client_ca_certificate QueryClientCaCertificateBody object 查询客户端CA证书响应对象 request_id string 请求id 表3 QueryClientCaCertificateBody 名称 类型 描述 id String 功能说明：证书ID 格式：36位UUID name String 功能说明：证书名称。 取值范围：1-64个字符，支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线) issuer String 功能说明：证书颁发者。 取值范围：1-256个字符。 subject String 功能说明：证书使用者。 取值范围：1-256个字符。 serial_number String 功能说明：CA证书序列号。 取值范围：1-64个字符。 expiration_time String 功能说明：证书到期时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ signature_algorithm String 功能说明：证书签名算法。 取值范围：1-64个字符。 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：最后更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 响应样例 { "client_ca_certificate": { "id": "ab80b8f6-6d67-4bdb-ba39-e8dd9419e64e", "name": "ca-cert-55f7", "issuer": "CN=xxx", "subject": "CN=xxx", "serial_number": "218730615113252363388323617489459159151767515623", "expiration_time": "2033-10-17T06:21:25Z", "signature_algorithm": "SHA256WITHRSA", "created_at": "2024-06-17T02:46:22.327Z", "updated_at": "2024-06-17T02:46:22.327Z" }, "request_id": "29d83bb1-5349-4af5-9fa6-672af3daf4d1" }

响应消息 响应参数 返回状态码为 200: successful operation。 表4 响应Body参数列表 名称 类型 描述 vpn_gateway ResponseVpnGateway object vpn_gateway对象。 request_id String 请求ID。 表5 ResponseVpnGateway 名称 类型 描述 id String 功能说明：VPN网关ID。 格式：36位UUID。 name String 功能说明：VPN网关名称。 取值范围：1-64个字符，包括数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 network_type 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。 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:ssZ。 updated_at String 最后一次更新时间。在VPN网关的状态为ACTIVE时返回。 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时返回。 ha_mode String 功能说明：网关的HA模式，"active-active"表示双活，"active-standby"表示主备。 取值范围：active-active，active-standby。 policy_template PolicyTemplate object 非固定IP接入VPN网关的策略模板配置，只有在规格为非固定IP接入VPN网关时返回。 tags Array of VpnResourceTag objects 标签列表。 表6 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，具体取值请参考弹性公网服务创建eip资料。 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。 表7 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike策略对象。 ipsec_policy IpsecPolicy object ipsec策略对象。 表8 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，单位：秒。 表9 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，单位：秒。 表10 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 vpn_gateway UpdateVgwSpecificationRequestBodyContent object 是 vpn_gateway对象 表3 UpdateVgwSpecificationRequestBodyContent 名称 类型 是否必选 描述 flavor String 是 功能说明：更新后的VPN网关规格 取值范围：Basic，Professional1，Professional2，Professional1-NonFixedIP，Professional2-NonFixedIP。 请求样例 POST https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}/update-specification { "vpn_gateway": { "flavor": "Basic" } }

响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 vpn_servers Array of ShowServerResponse objects 查询VPN服务端响应对象列表 request_id String 请求id 表3 ShowServerResponse 名称 类型 描述 id String 功能说明：VPN服务端 ID 格式：36位UUID p2c_vgw_id String 功能说明：P2C VPN网关ID 格式：36位UUID client_cidr String 功能说明：客户端网段。客户端建立连接时，会从该网段分配一个虚拟IP地址 格式："点分十进制/掩码"格式，例如192.168.1.0/24 local_subnets Array of strings 功能说明：本端网段列表 格式："点分十进制/掩码"格式，例如10.10.1.0/24 client_auth_type String 功能说明：客户端认证类型 取值范围： CERT：证书认证 LOCAL_PASSWORD：口令认证（本地） tunnel_protocol String 功能说明：隧道协议类型。 取值范围 SSL：SSL协议 server_certificate server_certificate object 服务端证书 client_ca_certificates Array of QueryClientCaCertificateBody objects 客户端CA证书列表，用于对客户端证书进行认证 ssl_options ssl_options object SSL隧道协议的可选配置项 status String 功能说明：服务端状态 取值范围： PENDING_CREATE：创建中 PENDING_UPDATE：更新中 ACTIVE：正常 FAULT：异常 FROZEN：冻结 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：最后更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 表4 server_certificate 名称 类型 描述 id String 证书ID，为CCM( 云证书管理服务 )中已上传证书的证书ID。若证书在CCM中被删除后，该ID为空 name String 证书名，为CCM( 云证书管理 服务)中已上传证书的证书名称 issuer String 功能说明：证书颁发者。 取值范围：1-256个字符。 subject String 功能说明：证书使用者。 取值范围：1-256个字符。 serial_number String 功能说明：证书序列号。 取值范围：1-64个字符。 expiration_time String 功能说明：到期时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ signature_algorithm String 功能说明：证书签名算法。 取值范围：1-64个字符。 表5 QueryClientCaCertificateBody 名称 类型 描述 id String 功能说明：证书ID 格式：36位UUID name String 功能说明：证书名称。 取值范围：1-64个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线) issuer String 功能说明：证书颁发者。 取值范围：1-256个字符。 subject String 功能说明：证书使用者。 取值范围：1-256个字符。 serial_number String 功能说明：CA证书序列号。 取值范围：1-64个字符。 expiration_time String 功能说明：证书到期时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ signature_algorithm String 功能说明：证书签名算法。 取值范围：1-64个字符。 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：最后更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 表6 ssl_options 名称 类型 描述 protocol string 功能说明：协议 取值范围： TCP port integer 功能说明：端口 取值范围： 443 1194 encryption_algorithm string 功能说明：加密算法 取值范围： AES-128-GCM AES-256-GCM authentication_algorithm string 功能说明：认证算法 取值范围： SHA256 SHA384 is_compressed boolean 功能说明：是否压缩，默认否 取值范围： true false 响应示例 { "vpn_servers": [ { "id": "3f7e48ca-cd3c-4ce2-a277-674382ce44ea", "p2c_vgw_id": "10d176c7-aed8-4766-9180-a47e536c64d0", "client_cidr": "173.16.1.0/24", "local_subnets": [ "172.16.0.0/24", "172.16.1.0/24" ], "client_auth_type": "CERT", "tunnel_protocol": "SSL", "server_certificate": { "id": "scs1698803781642", "name": "p2cvpn_test", "issuer": "CN=p2cvpn.test", "subject": "CN=p2cvpn.server", "serial_number": "109258411809374886820602321558250159914", "expiration_time": "2026-01-22T06:26:18Z", "signature_algorithm": "SHA256WITHRSA" }, "client_ca_certificates": [ { "id": "2f291995-9582-4ce8-a7f4-e1b7742e6e0c", "name": "client_ca_sdk_test_1", "issuer": "CN=p2cvpn.test", "subject": "CN=p2cvpn.test", "serial_number": "218730615113252363388323617489459159151767515623", "expiration_time": "2033-10-17T06:21:25Z", "signature_algorithm": "SHA256WITHRSA", "created_at": "2024-06-15T01:59:46.612Z", "updated_at": "2024-06-15T01:59:46.612Z" } ], "ssl_options": { "protocol": "TCP", "port": 443, "encryption_algorithm": "AES-128-GCM", "authentication_algorithm": "SHA256", "is_compressed": false }, "status": "ACTIVE", "created_at": "2024-06-15T01:59:46.612Z", "updated_at": "2024-06-15T02:01:16.606Z" }, { "id": "3840e9ea-84be-4ff9-ad26-817829ba16ed", "p2c_vgw_id": "30dfb9cd-eeb0-4937-a7a5-4bc08184090b", "client_cidr": "173.17.0.0/24", "local_subnets": [ "172.16.0.0/24", "172.16.1.0/24" ], "client_auth_type": "LOCAL_PASSWORD", "tunnel_protocol": "SSL", "server_certificate": { "id": "scs1698803781642", "name": "p2cvpn_test", "issuer": "CN=p2cvpn.test", "subject": "CN=p2cvpn.server", "serial_number": "109258411809374886820602321558250159914", "expiration_time": "2026-01-22T06:26:18Z", "signature_algorithm": "SHA256WITHRSA" }, "client_ca_certificates": [], "ssl_options": { "protocol": "TCP", "port": 443, "encryption_algorithm": "AES-128-GCM", "authentication_algorithm": "SHA256", "is_compressed": false }, "status": "ACTIVE", "created_at": "2024-06-15T02:01:19.87Z", "updated_at": "2024-06-15T02:01:19.87Z" } ], "request_id": "2b16014544fff455b50ef3f1e62bbe35" }

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 p2c_vpn_gateway UpdateP2cVgwRequestBodyContent object 是 p2c_vpn_gateway对象 表3 UpdateP2cVgwRequestBodyContent 名称 类型 必选 描述 name String 否 功能说明：P2C VPN网关名称 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线） eip_id String 否 功能说明：有效的EIP的ID，表示绑定新的EIP作为终端入云网关的EIP。绑定新的EIP前必须先解绑掉原有的EIP。可以通过解绑弹性公网IP解绑VPN网关使用的EIP。 约束：36位UUID 请求样例 PUT https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id} { "p2c_vpn_gateway": { "name": "p2c-vpngw-0003", "eip_id": "d9d85143-e1e1-427a-9994-d8b8fd9ebe3f" } }

响应消息 响应参数 返回状态码为 200: successful operation。 表4 响应Body参数列表 名称 类型 描述 p2c_vpn_gateway ResponseP2cVgw object P2C VPN网关 request_id String 请求ID 表5 ResponseP2cVgw 名称 类型 描述 id String 功能说明：P2C VPN网关ID 格式：36位UUID 响应样例 { "p2c_vpn_gateway": { "id": "10d176c7-aed8-4766-9180-a47e536c64d0" }, "request_id": "b19ba5a0be8f7b7f664b14596f8f35db" }

API概览 虚拟专用网络 提供的接口参见表1，各接口对应的权限说明请参见权限策略和授权项。 表1 VPN接口说明 类型 说明 站点入云VPN API VPN网关 站点入云VPN网关的创建、查询、更新、删除以及查询站点入云VPN网关可用区等接口。 对端网关 对端网关的创建、查询、更新、删除等接口。 VPN连接 VPN连接的创建、查询、更新、删除等接口。 VPN连接监控 VPN连接健康检查的创建、查询、删除等接口。 终端入云VPN API VPN网关 终端入云VPN网关的查询、修改、终端入云VPN网关可用区的查询以及终端入云网关连接信息列表的查询等接口。 服务端 服务端的创建、查询、修改和导出客户端配置，以及客户端CA证书的导入、查询、修改和删除等接口。 用户管理 VPN用户的创建、查询、修改、删除、修改密码和重置密码，以及VPN用户组的创建、查询、修改、删除、添加VPN用户到组、删除组内VPN用户和查询组内VPN用户等接口。 访问策略 VPN访问策略的创建、查询、修改和删除接口。 服务公共接口 VPN配额 配额查询接口。 VPN标签 标签查询、添加和删除等接口。

URI PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id} 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID vpn_server_id String 是 VPN服务端ID group_id String 是 用户组ID

响应消息 响应参数 返回状态码为 200: successful operation。 表4 响应Body参数列表 名称 类型 描述 user_group VpnUserGroup object VPN用户组对象 request_id String 请求ID 表5 VpnUserGroup 名称 类型 描述 id String 功能描述：VPN用户组ID 格式：36位UUID name String 用户组名称 description String 用户组描述 type String 功能说明：用户组类型 取值范围： Default：默认用户组 Custom：用户创建用户组 user_number Integer 用户数量 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 响应示例 { "user_group": { "id": "7625fd92-2e20-4e4d-8c56-66f110fbfaa8", "name": "user-group1-update", "description": "用户组1-update", "type": "Custom", "user_number": 0, "created_at": "2024-06-17T09:48:27.548Z", "updated_at": "2024-06-17T09:59:03.318Z" }, "request_id": "6735d32bb3e35e9154caba1dbc6c2dc6" }

响应消息 响应参数 返回状态码为 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:ssZ。 updated_at String 最后一次更新时间。 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.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.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.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.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.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.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连接。 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}

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一起使用。

响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 user VpnUser object VPN用户对象 request_id String 请求ID 表3 VpnUser 名称 类型 描述 id String 功能说明：用户ID 格式：36位UUID name String 用户名称 description String 用户描述 user_group_id String 功能说明：所属用户组ID 格式：36位UUID user_group_name String 所属用户组名称 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 响应样例 { "user": { "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d", "name": "user001", "description": "用户描述1", "user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W", "user_group_name": "user-group1", "created_at": "2024-06-17T06:53:46.302Z", "updated_at": "2024-06-17T06:53:46.302Z" }, "request_id": "926a0edb3bf432943e2399b700173add" }

URI GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/{user_id} 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 vpn_server_id String 是 VPN服务端ID user_id String 是 用户ID

响应消息 响应参数 返回状态码为 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:ssZ。 updated_at String 最后一次更新时间。在VPN网关的状态为ACTIVE时返回。 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，具体取值请参考弹性公网服务创建EIP资料。 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" }

URI POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID vpn_server_id String 是 VPN服务端ID 表2 请求Header参数列表 名称 类型 是否必选 描述 X-Client-Token String 否 功能说明：幂等性标识 格式：36位UUID

URI DELETE /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/{user_id} 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 vpn_server_id String 是 VPN服务端ID user_id String 是 用户ID

修订记录 表1 修订记录 发布日期 更新说明 2024-07-29 第七次正式发布。文档内容更新为： 新增站点入云VPN授权项列表、终端入云VPN授权项列表、服务公共接口授权项列表章节。 2024-06-30 第六次正式发布。文档内容更新为： 新增终端入云VPN网关、服务端、用户管理、访问策略、VPN配额、VPN标签章节。 新增修改网关规格章节。 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 第一次正式发布。

用户管理 权限 对应API接口 授权项（Action） 依赖的授权项 IAM 项目（Project） 企业项目（Enterprise Project） 创建VPN用户 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users vpn:p2cVpnUser:create - √ x 查询VPN用户列表 GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users vpn:p2cVpnUser:list - √ x 修改VPN用户 PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/{user_id} vpn:p2cVpnUser:update - √ x 查询VPN用户 GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/{user_id} vpn:p2cVpnUser:get - √ x 删除VPN用户 DELETE /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/{user_id} vpn:p2cVpnUser:delete - √ x 修改VPN用户密码 PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/{user_id}/password vpn:p2cVpnUser:updatePassword - √ x 重置VPN用户密码 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/{user_id}/reset-password vpn:p2cVpnUser:resetPassword - √ x 创建VPN用户组 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups vpn:p2cVpnGateway:createUserGroup - √ x 查询VPN用户组列表 GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups vpn:p2cVpnGateway:listUserGroup - √ x 修改VPN用户组 PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id} vpn:p2cVpnGateway:updateUserGroup - √ x 查询VPN用户组 GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id} vpn:p2cVpnGateway:getUserGroup - √ x 删除VPN用户组 DELETE /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id} vpn:p2cVpnGateway:deleteUserGroup - √ x 添加VPN用户到组 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/add-users vpn:p2cVpnGateway:addUsers - √ x 删除组内VPN用户 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/remove-users vpn:p2cVpnGateway:removeUsers - √ x 查询组内VPN用户 GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/users vpn:p2cVpnGateway:listUsersInGroup - √ x 父主题： 终端入云VPN授权项列表

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

响应消息 响应参数 返回状态码为 200: 查询成功。 表3 响应Body参数列表 名称 类型 描述 users Array of VpnUser objects 用户列表信息 total_count Integer 当前VPN服务端下的用户总数 page_info PageInfo object 分页查询页的信息 request_id String 请求ID 表4 VpnUser 名称 类型 描述 id String 功能说明：用户ID 格式：36位UUID name String 用户名称 description String 用户描述 user_group_id String 功能说明：所属用户组ID 格式：36位UUID user_group_name String 所属用户组名称 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 表5 PageInfo 名称 类型 描述 next_marker String 下一页的marker,值为上一次查询响应中最后一个资源的创建时间 current_count Integer 当前列表中资源数量 响应样例 { "users": [ { "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d", "name": "user001", "description": "用户描述1", "user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W", "user_group_name": "user-group1", "created_at": "2024-06-17T06:53:46.302Z", "updated_at": "2024-06-17T06:53:46.302Z" }, { "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d", "name": "user002", "description": "用户描述2", "user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W", "user_group_name": "user-group1", "created_at": "2024-06-17T06:53:46.302Z", "updated_at": "2024-06-17T06:53:46.302Z" } ], "total_count": 2, "page_info": { "next_marker": null, "current_count": 2 }, "request_id": "b04b68fb4d548344e0bc4b34dbd6f6e7" }