VPN连接
VPN连接
文档指南
请输入
快速入门
IPsec VPN快速入门
用户指南
SSL VPN连接
最佳实践
VPC与云下数据中心互通
API参考
VPN网关
用户网关
IPsec连接
VPN连接健康检查
SSL服务端
SSL客户端证书
VPN网关路由
故障处理
- 文档首页
VPN连接API参考调用方式返回示例
复制全文
下载 pdf返回示例
文档反馈
问问助手所有的返回数据都会带上RequestId，Action，Version，Service，Region这几个字段。
正常返回示例
接口调用成功后会返回请求ID和接口返回参数，我们称这样的返回为正常返回。正常返回HTTP状态码为2xx。
以调用CreateVpnGateway为例，正常的返回示例如下：
{
"ResponseMetadata": {
"RequestId": "202004011722300102****", //RequestId为每次API请求的唯一标识。
"Action": "CreateVpnGateway",//请求的API名称，属于请求的公共参数。
"Version": "2020-04-01",//请求的版本号。
"Service": "vpn",//请求的服务。
"Region": "cn-beijing" //请求的地域。
},
"Result": {
"RequestId":"2022032111142501022524314704AF****",
"OrderId":"Order7078570823273845****", //返回的结果。
"VpnGatewayId":"vgw-12bfa2du7fojk17q7y1rk****"
}
}
请求被正常处理后，返回中会包含ResponseMetadata和Result两部分，字段解释如下：
字段 | 解释 |
字段 | 解释 |
RequestId | RequestId为每次API请求的唯一标识。 |
Action | 请求的接口名，属于请求的公共参数。 |
Version | 请求的版本号，属于请求的公共参数。 |
Service | 请求的服务，属于请求的公共参数。 |
说明
Result视请求的接口而定，不同的接口会有不同的Result返回。
异常返回示例
接口调用出错后，会返回请求ID和错误信息，我们称这样的返回为异常返回。异常返回的HTTP状态码为4xx或者5xx。您可以根据接口错误代码（Code）和错误信息（Message），参考公共错误码和接口错误码排查错误。
以调用CreateVpnGateway为例，异常的返回示例如下：
{
"ResponseMetadata": {
"RequestId": "202010201722300102****",
"Action": "CreateVpnGateway",
"Version": "2020-04-01",
"Service": "vpn",
"Region": "cn-beijing",
"Error": {
"Code": "InvalidBillingType.Malformed",
"Message": "The specified billing type is malformed."
}
}
}
相较于正常返回结果，异常结果将不再有Result部分，而ResponseMetadata中将额外出现Error字段，字段解释如下：
字段 | 解释 |
字段 | 解释 |
Error | Error出现表明本次请求失败。 |
Code | Code内容为具体的错误码，您可查询对应API的错误码文档，自助解决问题。 |
CodeN | CodeN为标识错误码的数字ID，方便查找问题，仅部分接口会提供CodeN。 |
Message | Message描述了错误发生的具体原因。 |
RequestId |
最近更新时间：2025.01.16 14:41:17
这个页面对您有帮助吗？
有用
有用
无用
无用