文档

GetVpnGatewayDiagnoseResult - 查询VPN网关实例的一键诊断结果

更新时间:

调用GetVpnGatewayDiagnoseResult接口查询VPN网关实例的一键诊断结果。

接口说明

调用 GetVpnGatewayDiagnoseResult 接口时,除必填参数外,DiagnoseIdVpnGatewayId 参数需至少输入一个。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

VPN 网关实例所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-qingdao
DiagnoseIdstring

诊断 ID。

在您 DiagnoseVpnGateway 调用接口时,系统会返回对应的诊断 ID。

vpndgn-uf6kuxbe3iv028k3s****
VpnGatewayIdstring

VPN 网关实例 ID。

vpn-uf6fzwp0ck3frwtbk****
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-001****

返回参数

名称类型描述示例值
object

返回结果。

BeginTimestring

诊断开始的时间。

时间按照 ISO8601 标准表示,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ

2022-12-15T05:28:57Z
DiagnoseIdstring

诊断 ID。

vpndgn-uf6sgneym02lxyuv4****
DiagnoseResultobject []

诊断项信息列表。

DiagnoseNamestring

诊断项。

  • RouteEntryConflict:路由冲突。
  • VpnRouteQuota:VPN 网关目的路由配额。
  • VpnIPsecQuota:VPN 网关 IPsec 连接配额。
  • VpnPbrRouteQuota:VPN 网关策略路由配额。
  • VcoConfigConsistency:IPsec 配置一致性。
  • VcoUserInternetIpConnectivity:用户网关公网连通性。
  • VcoPrivateConnectivity:私网连通性。

关于每个诊断项的说明信息,请参见一键诊断背景信息

RouteEntryConflict
DiagnoseResultDescriptionstring

诊断项的诊断结果。

针对每个诊断项,接口会返回不同的信息,说明如下:

  • RouteEntryConflict:系统会返回对应路由冲突的信息。
  • VpnRouteQuota
    • quotaName:目的路由配额 ID。
    • quantity:当前 VPN 网关实例支持创建的目的路由条目数量。
    • used:当前 VPN 网关实例已创建的目的路由条目数量。
  • VpnIPsecQuota
    • quotaName:IPsec 连接配额 ID。
    • quantity:当前 VPN 网关实例支持创建的 IPsec 连接数量。
    • used:当前 VPN 网关实例已创建的 IPsec 连接数量。
  • VpnPbrRouteQuota
    • quotaName:策略路由配额 ID。
    • quantity:当前 VPN 网关实例支持创建的策略路由条目数量。
    • used:当前 VPN 网关实例已创建的策略路由条目数量。
  • VcoConfigConsistency
    • vcoLackConf:系统无法获取 IPsec 连接对端的配置。
    • vcoRunningConf:IPsec 连接对端已添加的配置信息。
    • vcoDiffConf:IPsec 连接侧(本端)和对端不一致的配置列表。
    • vcoConf:IPsec 连接侧(本端)已添加的配置信息。
  • VcoUserInternetIpConnectivity
    • targetIp:用户网关的公网 IP 地址。
    • rtt:系统访问用户网关公网 IP 地址时的时延。单位:ms。
    • lossRate:系统访问用户网关公网 IP 地址时的丢包率。
  • VcoPrivateConnectivity
    • targetIp:源 IP 地址。
    • srcIp:目的 IP 地址。
    • rtt:源 IP 地址访问目的 IP 地址时的时延。单位:ms。
    • lossRate:源 IP 地址访问目的 IP 地址时的丢包率。
{\"targetIp\":\"192.168.0.1\",\"srcIp\":\"192.168.1.1\",\"rtt\":-1.0,\"lossRate\":100.0}
DiagnoseResultLevelstring

诊断项的诊断结果级别。

  • normal:正常。
  • warning:警告。
  • error:异常。

关于每个诊断项对应的每个诊断结果级别的说明,请参见一键诊断背景信息

normal
FinishTimestring

诊断结束的时间。

时间按照 ISO8601 标准表示,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ

2022-12-15T05:29:08Z
FinishedCountinteger

已完成诊断的诊断项数量。

7
RequestIdstring

请求 ID。

312C4D5A-6563-5FC6-8C6E-A43A5A316FEB
ResourceInstanceIdstring

诊断的资源 ID。

vco-uf6huqsu63azl7mdp****
ResourceTypestring

诊断的资源类型。

取值:IPsec,表示 IPsec 连接。

IPsec
TotalCountinteger

诊断项总数。

7
VpnGatewayIdstring

VPN 网关实例 ID。

vpn-uf6fzwp0ck3frwtbk****

示例

正常返回示例

JSON格式

{
  "BeginTime": "2022-12-15T05:28:57Z",
  "DiagnoseId": "vpndgn-uf6sgneym02lxyuv4****",
  "DiagnoseResult": [
    {
      "DiagnoseName": "RouteEntryConflict",
      "DiagnoseResultDescription": "{\\\"targetIp\\\":\\\"192.168.0.1\\\",\\\"srcIp\\\":\\\"192.168.1.1\\\",\\\"rtt\\\":-1.0,\\\"lossRate\\\":100.0}",
      "DiagnoseResultLevel": "normal"
    }
  ],
  "FinishTime": "2022-12-15T05:29:08Z",
  "FinishedCount": 7,
  "RequestId": "312C4D5A-6563-5FC6-8C6E-A43A5A316FEB",
  "ResourceInstanceId": "vco-uf6huqsu63azl7mdp****",
  "ResourceType": "IPsec",
  "TotalCount": 7,
  "VpnGatewayId": "vpn-uf6fzwp0ck3frwtbk****"
}

错误码

HTTP status code错误码错误信息描述
400param_errorThe param is must be in ...-
400MissingParam.DiagnoseInfoThe VPN gateway ID and diagnose ID cannot be empty at the same time.-
400VpnGateway.ConfiguringThe specified service is configuring.服务正在配置中,请您稍后再试。
400IncorrectStatus.DiagnoseTimeoutDiagnose failed because of timeout.-
400IncorrectStatus.VpnConnectionDeletedDiagnose failed because the VPN connection has been deleted.-
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
404InvalidDiagnoseId.NotFoundThe specified diagnose ID [%s] does not exist.-
404InvalidVpnGatewayId.NotFoundThe specified VPN gateway [%s] does not have any diagnoses.-
404InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)