华为云用户手册

响应消息 响应参数 返回状态码为 201: successful operation。 表5 响应Body参数列表 名称 类型 描述 client_ca_certificate client_ca_certificate object 客户端CA证书对象。 request_id String 请求id。 表6 client_ca_certificate 名称 类型 描述 id String 功能说明：客户端CA证书ID。 格式：36位UUID。 响应示例 { "client_ca_certificate": { "id": "4e3a364f-1213-4a37-917e-d494aeada34e" }, "request_id": "4114fdd9ca33e22936ece75b97d7a363" }

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

请求消息 请求参数 表3 请求参数 名称 类型 是否必选 描述 client_ca_certificate client_ca_certificate object 是 客户端CA证书。 表4 client_ca_certificate 名称 类型 必选 描述 name String 否 证书名称，不填时自动生成。 取值范围：1-64个字符，支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 content String 是 功能说明：证书内容，推荐使用强密码算法的证书，如RSA3072/4096。 格式： -----BEGIN CERTIFICATE----- ************************************* ************************************* -----END CERTIFICATE----- 请求样例 POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates { "client_ca_certificate": { "name": "client_ca_8sux3d", "content": "-----BEGIN CERTIFICATE-----********-----END CERTIFICATE-----" } }

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 client_ca_certificate client_ca_certificate object 是 客户端CA证书。 表3 client_ca_certificate 名称 类型 必选 描述 name String 否 功能说明：证书名称。 取值范围：1-64个字符，支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 content String 是 功能说明：证书内容。 格式： -----BEGIN CERTIFICATE----- ************************************* ************************************* -----END CERTIFICATE----- 请求样例 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/client-ca-certificates/check { "client_ca_certificate": { "name": "client_ca_8sux3d", "content": "-----BEGIN CERTIFICATE-----******-----END CERTIFICATE-----" } }

响应消息 响应参数 返回状态码为 200: successful operation。 表4 响应Body参数列表 名称 类型 描述 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个字符。 响应示例 校验通过响应： { "name": "client_ca_8sux3d", "issuer": "CN=xxx", "subject": "CN=xxx", "serial_number": "621079609299744022526309164429940520767604766768", "expiration_time": "2033-08-05T11:52:34Z", "signature_algorithm": "SHA256WITHRSA" } 校验不通过响应： { "error_code": "VPN.0072", "error_msg": "Certificate client_ca_8sux3d has expired.", "request_id": "b012532f51675c0ffdcfb2868669bd4e" }

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 os_type String 否 功能说明：操作系统类型。 取值范围 Windows Linux MacOS Android iOS 默认值：Windows。 请求样例 POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-config/export { "os_type": "Windows" }

请求消息 请求参数 无。 请求样例 1.不分页查询连接列表。 GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections 2.分页查询连接列表。 GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections?limit=10&offset=0

URI GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID p2c_vgw_id String 是 P2C VPN网关实例ID 表2 请求Query参数列表 名称 类型 是否必选 描述 limit Integer 否 分页查询时每页返回的记录数量 offset Integer 否 分页查询的偏移量

响应消息 响应参数 返回状态码为 200: 查询成功。 表3 响应Body参数列表 名称 类型 描述 connections Array of Connection objects 连接信息 total_count Long 连接总数 request_id String 请求ID 表4 Connection 名称 类型 描述 connection_id String 功能说明：连接ID 格式：36位UUID client_virtual_ip String 客户端连接时分配的虚拟IP地址 client_ip String 客户端连接的公网IP地址 client_user_name String 客户端用户名称 inbound_packets Long 入网包数 outbound_packets Long 出网包数 inbound_bytes Long 入网字节数 outbound_bytes Long 出网字节数 connection_established_time String 功能说明：客户端连接的建立时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ timestamp String 功能说明：连接流量信息统计的时间戳 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ

响应消息 响应参数 返回状态码为 200: successful operation。 表3 响应Body参数列表 名称 类型 描述 availability_zones Array of strings 可用区列表 request_id String 请求id 响应样例 { "availability_zones": [ "cn-south-1f", "cn-south-1e" ], "request_id": "c63d850876bcddbdfbd11776cce57914" }

URI GET /v5/{project_id}/p2c-vpn-gateways/availability-zones 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID 表2 请求Query参数列表 名称 类型 是否必选 描述 flavor String 否 功能说明：P2C VPN网关的规格类型。 取值范围: Professional1：专业型1。

请求消息 请求参数 表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" }

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

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

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

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

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

URI POST /v5/{project_id}/{resource_type}/{resource_id}/tags/delete 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 resource_type String 是 功能说明：资源类型。 取值范围：vpn-gateway，customer-gateway，vpn-connection，p2c-vpn-gateways。 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" }] }

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，p2c-vpn-gateways。 resource_id String 是 资源ID。

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 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为固定字典值。 表3 Tag 名称 类型 是否必选 描述 key String 是 功能说明：标签的键。 取值范围：1-128个字符。 values Array of String 是 功能说明：标签的值列表。如果values为空列表，则表示any_value。value之间为或的关系。 取值范围：0-255个字符。 约束：最多填写20个。 表4 Match 名称 类型 是否必选 描述 key String 是 功能说明：匹配的键。 取值范围：resource_name。 value String 是 功能说明：匹配的值。 取值范围：0-255个字符。 请求样例 POST https://{Endpoint}/v5/{project_id}/{resource_type}/resource-instances/count { "tags": [{ "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [{ "key": "resource_name", "value": "resource1" }], "without_any_tag": "false" }

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

响应消息 响应参数 返回状态码为 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，p2c-vpn-gateways。 表2 请求Query参数列表 名称 类型 是否必选 描述 limit Integer 否 功能说明：查询记录数。 取值范围：1-1000。 默认值：1000。 offset Integer 否 功能说明：索引位置。从第offset条数据的下一条数据开始查询。 取值范围：最小值为0。 默认值：0。

请求消息 请求参数 表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" }

状态码 表1 正常返回值 正常返回码 类型 说明 200 OK GET、PUT操作正常返回。 201 Created POST操作正常返回。 204 No Content DELETE操作正常返回。 表2 异常返回值 返回值 类型 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 附录

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为 IAM 的终端节点。接口的认证鉴权请参见认证鉴权章节。 响应示例如下，其中projects下的“id”即为项目ID。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

权限及授权项说明 如果您需要对您所拥有的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网关等接口。 “√”表示支持，“x”表示暂不支持。 父主题： 权限和授权项

操作步骤 创建VPN连接监控。 发送“POST https://{endpoint}/v5/{project_id}/connection-monitors”，project_id为项目ID。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下。 { "connection_monitor": { "vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220" } } 查看请求响应结果。 请求成功时，响应参数如下，id就是VPN连接监控的ID。 { "connection_monitor": { "id": "76f64229-demo-a8df-va86-3907e2815b6d", "vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220", "type": "gateway", "source_ip": "88.***.***.60", "destination_ip": "192.***.***.0", "proto_type": "icmp" }, "request_id": "54af23d8-989e-445d-bb48-0a9da33d7f0f" } 查询VPN连接监控详情。 发送“GET https://{endpoint}/v5/{project_id}/connection-monitors/{connection_monitor_id}”，project_id为项目ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，响应参数如下，id就是VPN连接监控的ID。 { "connection_monitor": { "id": "76f64229-demo-a8df-va86-3907e2815b6d", "status": "ACTIVE", "vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220", "type": "gateway", "source_ip": "88.***.***.60", "destination_ip": "192.***.***.0", "proto_type": "icmp" }, "request_id": "72d05395-0637-4f93-9844-b4979e9d7bdc" }