检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询VPN网关可用区 功能介绍 查询VPN网关可用区。 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/vpn-gateways/availability-zones 表1 参数说明 名称 类型 是否必选 说明 project_id String
查询项目标签 功能介绍 查询租户在指定项目中指定资源类型下的所有标签。 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/{resource_type}/tags 表1 参数说明 名称 类型 是否必选 描述 project_id String 是
查询P2C VPN网关可用区 功能介绍 查询P2C VPN网关可用区。 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/p2c-vpn-gateways/availability-zones 表1 参数说明 名称 类型 是否必选 描述 project_id
查询资源标签 功能介绍 查询指定实例的标签信息。 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/{resource_type}/{resource_id}/tags 表1 参数说明 名称 类型 是否必选 描述 project_id String
查询资源实例数量 功能介绍 根据标签查询资源实例数量。 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/{resource_type}/resource-instances/count 表1 参数说明 名称 类型 是否必选 说明 project_id
查询P2C VPN网关连接信息列表 功能介绍 根据P2C VPN网关ID,查询连接列表。 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections 表1 参数说明 名称 类型
查询资源实例列表 功能介绍 根据标签查询资源实例列表。 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/{resource_type}/resource-instances/filter 表1 参数说明 名称 类型 是否必选 说明 project_id
附录 获取项目ID 状态码 错误码
应用示例 示例一:创建站点入云VPN网关 示例二:创建对端网关 示例三:创建VPN连接 示例四:创建VPN连接监控 示例五:创建服务端 示例六:创建用户和用户组 示例七:创建访问策略
状态码 表1 正常返回值 正常返回码 类型 说明 200 OK GET、PUT操作正常返回。 201 Created POST操作正常返回。 204 No Content DELETE操作正常返回。 表2 异常返回值 返回值 类型 说明 400 Bad Request 服务器未能处理请求。
发布日期 更新说明 2024-07-29 第七次正式发布。文档内容更新为: 新增站点入云VPN授权项列表、终端入云VPN授权项列表、服务公共接口授权项列表章节。 2024-06-30 第六次正式发布。文档内容更新为: 新增终端入云VPN网关、服务端、用户管理、访问策略、VPN配额、VPN标签章节。
State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 同时VPN服务还提供API Explorer供您使用,详情请参见API Explorer。 终端节点(Endpoint) 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同。
权限和授权项 权限及授权项说明 站点入云VPN授权项列表 终端入云VPN授权项列表 服务公共接口授权项列表
错误码 功能说明 API调用发生错误时,会有错误结构体返回,该小节主要是对VPN封装接口(不包括OpenStack原生接口)错误结构的解释。 返回体格式 { "code": "VPN.0001", "message": "invalid request:xxx"
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID。 从控制台获取项目ID。 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https
本章节指导用户通过调用API来创建访问策略。 前提条件 已创建终端入云VPN网关。 已创建VPN服务端,且服务端的认证方式为口令认证,具体参见创建服务端。 您需要确定调用API的Endpoint。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-A
示例五:创建服务端 操作场景 本章节指导用户通过调用API来创建VPN服务端。 前提条件 已成功创建包周期终端入云VPN网关。 已在云证书管理服务中购买或上传服务端证书,详情请参见购买SSL证书和上传已有SSL证书。 您需要确定调用API的Endpoint。 当您使用Token认证方式
须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要调用接口来查询VPN 网关列表,那么这个IAM用户被授予的策略中必须包含允许“vpn:v
本章节指导用户通过调用API来创建VPN连接。 前提条件 已创建VPN网关。具体请参见创建VPN网关。 已创建对端网关。具体请参见创建对端网关。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。To
示例四:创建VPN连接监控 操作场景 本章节指导用户通过调用API来创建VPN连接监控。 前提条件 已创建VPN连接。具体请参见创建VPN连接。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证,具体操作请参考认证鉴权章节。