华为云用户手册

  • VPN连接 权限 对应API接口 授权项(Action) 依赖的授权项 IAM 项目(Project) 企业项目(Enterprise Project) 创建VPN连接 POST /v5/{project_id}/vpn-connection vpn:vpnConnections:create ces:metricData:list ces:currentRegionSupportedMetrics:list vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list vpc:subNetworkInterfaces:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 查询VPN连接列表 GET /v5/{project_id}/vpn-connection vpn:vpnConnections:list vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list √ × 查询VPN连接详情 GET /v5/{project_id}/vpn-connection/{vpn_connection_id} vpn:vpnConnections:get vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list √ √ 更新VPN连接 PUT /v5/{project_id}/vpn-connection/{vpn_connection_id} vpn:vpnConnections:update vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list vpc:subNetworkInterfaces:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 删除VPN连接 DELETE /v5/{project_id}/vpn-connection/{vpn_connection_id} vpn:vpnConnections:delete ces:metricData:list ces:currentRegionSupportedMetrics:list vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subNetworkInterfaces:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 父主题: 站点入云VPN授权项列表
  • URI PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/{user_id}/password 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID,可以通过获取项目ID获取项目ID vpn_server_id String 是 VPN服务端ID user_id String 是 VPN用户ID
  • 请求消息 请求参数 表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
  • 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" }
  • 对端网关 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目(Project) 企业项目(Enterprise Project) 创建对端网关 POST /v5/{project_id}/customer-gateways vpn:customerGateways:create - √ x 查询对端网关详情 GET /v5/{project_id}/customer-gateways/{customer_gateway_id} vpn:customerGateways:get - √ x 查询对端网关列表 GET /v5/{project_id}/customer-gateways vpn:customerGateways:list - √ x 更新对端网关 PUT /v5/{project_id}/customer-gateways/{customer_gateway_id} vpn:customerGateways:update - √ x 删除对端网关 DELETE /v5/{project_id}/customer-gateways/{customer_gateway_id} vpn:customerGateways:delete - √ x 父主题: 站点入云VPN授权项列表
  • 响应消息 响应参数 返回状态码为 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" }
  • 响应消息 响应参数 返回状态码为 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" }
  • 请求消息 请求参数 表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" } }
  • 服务端 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目(Project) 企业项目(Enterprise Project) 创建终端入云VPN服务端 POST /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/vpn-servers vpn:p2cVpnGateway:createServer scm:cert:get scm:cert:list scm:cert:download vpc:publicIps:get vpc:routeTables:update vpc:subnets:get √ x 查询一个网关下的服务端信息 GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/vpn-servers vpn:p2cVpnGateway:listServers - √ x 更新指定网关的服务端 PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id} vpn:p2cVpnGateway:updateServer scm:cert:get scm:cert:list scm:cert:download vpc:publicIps:get vpc:routeTables:update vpc:subnets:get √ x 导出服务端对应的客户端配置信息 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-config/export vpn:p2cVpnGateway:exportClientConfig - √ x 校验CA证书的合法性 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/client-ca-certificates/check vpn:system:checkClientCaCertificate - √ x 导入客户端CA证书 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates vpn:p2cVpnGateway:importClientCa - √ x 修改客户端CA证书 PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates/{client_ca_certificate_id} vpn:p2cVpnGateway:updateClientCa - √ x 查询客户端CA证书 GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates/{client_ca_certificate_id} vpn:p2cVpnGateway:getClientCa - √ x 删除客户端CA证书 DELETE /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates/{client_ca_certificate_id} vpn:p2cVpnGateway:deleteClientCa - √ x 查询租户下的所有服务端信息 GET /v5/{project_id}/vpn-servers vpn:p2cVpnGateway:listAllServers - √ x 父主题: 终端入云VPN授权项列表
  • 响应消息 响应参数 返回状态码为 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" }
  • 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: 查询成功。 表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
  • 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
  • 用户管理 权限 对应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}/access-policies/{policy_id} 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID,可以通过获取项目ID获取项目ID。 vpn_server_id String 是 VPN服务端ID policy_id String 是 访问策略ID
  • 响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 access_policy VpnAccessPolicy object VPN访问策略对象 request_id String 请求ID 表3 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": "4f746482-a575-4e1f-9e80-5f6f69ff8588", "name": "policy-001", "user_group_id": "7625fd92-2e20-4e4d-8c56-66f110fbfaa8", "user_group_name": "user-group1", "description": "访问策略1", "dest_ip_cidrs": [ "172.16.0.0/24", "172.16.1.0/24" ], "created_at": "2024-06-17T13:32:19.57Z", "updated_at": "2024-06-17T13:32:19.57Z" }, "request_id": "85657002f01c35576606003cc36114ab" }
  • 请求消息 请求参数 表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-----" } }
  • 响应消息 响应参数 返回状态码为 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
  • URI DELETE /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
  • 响应消息 响应参数 返回状态码为 201: successful operation。 表5 响应Body参数列表 名称 类型 描述 user user object VPN用户对象 request_id String 请求ID 表6 user 名称 类型 描述 id String 功能说明:VPN用户ID 格式:36位UUID 响应样例 { "user": { "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d" }, "request_id": "b19ba5a0be8f7b7f664b14596f8f35db" }
  • URI POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID,可以通过获取项目ID获取项目ID vpn_server_id String 是 VPN服务端ID 表2 请求Header参数列表 名称 类型 是否必选 描述 X-Client-Token String 否 功能说明:幂等性标识 格式:36位UUID
  • 请求消息 请求参数 表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" }
  • 响应消息 响应参数 返回状态码为 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" }
共100000条