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

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetVpnGatewayDiagnoseResult

系统规定参数。取值:GetVpnGatewayDiagnoseResult

RegionId String cn-qingdao

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

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

DiagnoseId String vpndgn-uf6kuxbe3iv028k3s****

诊断ID。

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

VpnGatewayId String vpn-uf6fzwp0ck3frwtbk****

VPN网关实例ID。

ClientToken String 02fb3da4-130e-11e9-8e44-001****

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。

返回数据

名称 类型 示例值 描述
BeginTime String 2022-12-15T05:28:57Z

诊断开始的时间。

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

DiagnoseId String vpndgn-uf6sgneym02lxyuv4****

诊断ID。

DiagnoseResult Array of DiagnoseResult

诊断项信息列表。

DiagnoseName String RouteEntryConflict

诊断项。

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

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

DiagnoseResultDescription String {\"targetIp\":\"192.168.0.1\",\"srcIp\":\"192.168.1.1\",\"rtt\":-1.0,\"lossRate\":100.0}

诊断项的诊断结果。

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

  • 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地址时的丢包率。
DiagnoseResultLevel String normal

诊断项的诊断结果级别。

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

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

FinishTime String 2022-12-15T05:29:08Z

诊断结束的时间。

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

FinishedCount Integer 7

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

RequestId String 312C4D5A-6563-5FC6-8C6E-A43A5A316FEB

请求ID。

ResourceInstanceId String vco-uf6huqsu63azl7mdp****

诊断的资源ID。

ResourceType String IPsec

诊断的资源类型。

取值:IPsec,表示IPsec连接。

TotalCount Integer 7

诊断项总数。

VpnGatewayId String vpn-uf6fzwp0ck3frwtbk****

VPN网关实例ID。

示例

请求示例

http(s)://[Endpoint]/?Action=GetVpnGatewayDiagnoseResult
&RegionId=cn-qingdao
&DiagnoseId=vpndgn-uf6kuxbe3iv028k3s****
&VpnGatewayId=vpndgn-uf6sgneym02lxyuv4****
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetVpnGatewayDiagnoseResultResponse>
    <TotalCount>7</TotalCount>
    <FinishTime>2022-12-15T05:29:08Z</FinishTime>
    <RequestId>312C4D5A-6563-5FC6-8C6E-A43A5A316FEB</RequestId>
    <VpnGatewayId>vpn-uf6fzwp0ck3frwtbk****</VpnGatewayId>
    <FinishedCount>7</FinishedCount>
    <DiagnoseId>vpndgn-uf6sgneym02lxyuv4****</DiagnoseId>
    <BeginTime>2022-12-15T05:28:57Z</BeginTime>
    <ResourceType>IPsec</ResourceType>
    <ResourceInstanceId>vco-uf6huqsu63azl7mdp****</ResourceInstanceId>
    <DiagnoseResult>
        <DiagnoseResultLevel>normal</DiagnoseResultLevel>
        <DiagnoseResultDescription>No routing conflict</DiagnoseResultDescription>
        <DiagnoseName>RouteEntryConflict</DiagnoseName>
    </DiagnoseResult>
    <DiagnoseResult>
        <DiagnoseResultLevel>normal</DiagnoseResultLevel>
        <DiagnoseResultDescription>{"quotaName":"vpn_route_entry_quota","quantity":"30","used":"0"}</DiagnoseResultDescription>
        <DiagnoseName>VpnRouteQuota</DiagnoseName>
    </DiagnoseResult>
    <DiagnoseResult>
        <DiagnoseResultLevel>normal</DiagnoseResultLevel>
        <DiagnoseResultDescription>{"quotaName":"vpn_quota_ipsec_connetcions_num","quantity":"10","used":"1"}</DiagnoseResultDescription>
        <DiagnoseName>VpnIPsecQuota</DiagnoseName>
    </DiagnoseResult>
    <DiagnoseResult>
        <DiagnoseResultLevel>normal</DiagnoseResultLevel>
        <DiagnoseResultDescription>{"quotaName":"vpn_pbr_route_entry_quota","quantity":"20","used":"0"}</DiagnoseResultDescription>
        <DiagnoseName>VpnPbrRouteQuota</DiagnoseName>
    </DiagnoseResult>
    <DiagnoseResult>
        <DiagnoseResultLevel>warning</DiagnoseResultLevel>
        <DiagnoseResultDescription>{"vcoLackConf":["leftid","rightid","right","leftsubnets","rightsubnets","ike_auth_alg","ike_enc_alg","ike_lifetime","ipsec_auth_alg","ipsec_enc_alg","ipsec_lifetime","nat_traversal","dpd","ike_pfs","ipsec_pfs"],"vcoRunningConf":{},"vcoDiffConf":{},"vcoConf":{"ipsec_lifetime":"86400","ike_pfs":"group2","ike_enc_alg":"aes","leftsubnets":"0.0.0.0/0","nat_traversal":"true","leftid":"47.XX.XX.15","right":"1.XX.XX.1","rightsubnets":"0.0.0.0/0","ipsec_pfs":"group2","ike_auth_alg":"sha1","ike_lifetime":"86400","rightid":"1.XX.XX.1","dpd":"true","ipsec_auth_alg":"sha1","ipsec_enc_alg":"aes"}}</DiagnoseResultDescription>
        <DiagnoseName>VcoConfigConsistency</DiagnoseName>
    </DiagnoseResult>
    <DiagnoseResult>
        <DiagnoseResultLevel>error</DiagnoseResultLevel>
        <DiagnoseResultDescription>{"targetIp":"1.XX.XX.1","rtt":-1.0,"lossRate":100.0}</DiagnoseResultDescription>
        <DiagnoseName>VcoUserInternetIpConnectivity</DiagnoseName>
    </DiagnoseResult>
    <DiagnoseResult>
        <DiagnoseResultLevel>error</DiagnoseResultLevel>
        <DiagnoseResultDescription>{"targetIp":"192.168.0.1","srcIp":"192.168.1.1","rtt":-1.0,"lossRate":100.0}</DiagnoseResultDescription>
        <DiagnoseName>VcoPrivateConnectivity</DiagnoseName>
    </DiagnoseResult>
</GetVpnGatewayDiagnoseResultResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 7,
  "FinishTime" : "2022-12-15T05:29:08Z",
  "RequestId" : "312C4D5A-6563-5FC6-8C6E-A43A5A316FEB",
  "VpnGatewayId" : "vpn-uf6fzwp0ck3frwtbk****",
  "FinishedCount" : 7,
  "DiagnoseId" : "vpndgn-uf6sgneym02lxyuv4****",
  "BeginTime" : "2022-12-15T05:28:57Z",
  "ResourceType" : "IPsec",
  "ResourceInstanceId" : "vco-uf6huqsu63azl7mdp****",
  "DiagnoseResult" : [ {
    "DiagnoseResultLevel" : "normal",
    "DiagnoseResultDescription" : "No routing conflict",
    "DiagnoseName" : "RouteEntryConflict"
  }, {
    "DiagnoseResultLevel" : "normal",
    "DiagnoseResultDescription" : "{\"quotaName\":\"vpn_route_entry_quota\",\"quantity\":\"30\",\"used\":\"0\"}",
    "DiagnoseName" : "VpnRouteQuota"
  }, {
    "DiagnoseResultLevel" : "normal",
    "DiagnoseResultDescription" : "{\"quotaName\":\"vpn_quota_ipsec_connetcions_num\",\"quantity\":\"10\",\"used\":\"1\"}",
    "DiagnoseName" : "VpnIPsecQuota"
  }, {
    "DiagnoseResultLevel" : "normal",
    "DiagnoseResultDescription" : "{\"quotaName\":\"vpn_pbr_route_entry_quota\",\"quantity\":\"20\",\"used\":\"0\"}",
    "DiagnoseName" : "VpnPbrRouteQuota"
  }, {
    "DiagnoseResultLevel" : "warning",
    "DiagnoseResultDescription" : "{\"vcoLackConf\":[\"leftid\",\"rightid\",\"right\",\"leftsubnets\",\"rightsubnets\",\"ike_auth_alg\",\"ike_enc_alg\",\"ike_lifetime\",\"ipsec_auth_alg\",\"ipsec_enc_alg\",\"ipsec_lifetime\",\"nat_traversal\",\"dpd\",\"ike_pfs\",\"ipsec_pfs\"],\"vcoRunningConf\":{},\"vcoDiffConf\":{},\"vcoConf\":{\"ipsec_lifetime\":\"86400\",\"ike_pfs\":\"group2\",\"ike_enc_alg\":\"aes\",\"leftsubnets\":\"0.0.0.0/0\",\"nat_traversal\":\"true\",\"leftid\":\"47.XX.XX.15\",\"right\":\"1.XX.XX.1\",\"rightsubnets\":\"0.0.0.0/0\",\"ipsec_pfs\":\"group2\",\"ike_auth_alg\":\"sha1\",\"ike_lifetime\":\"86400\",\"rightid\":\"1.XX.XX.1\",\"dpd\":\"true\",\"ipsec_auth_alg\":\"sha1\",\"ipsec_enc_alg\":\"aes\"}}",
    "DiagnoseName" : "VcoConfigConsistency"
  }, {
    "DiagnoseResultLevel" : "error",
    "DiagnoseResultDescription" : "{\"targetIp\":\"1.XX.XX.1\",\"rtt\":-1.0,\"lossRate\":100.0}",
    "DiagnoseName" : "VcoUserInternetIpConnectivity"
  }, {
    "DiagnoseResultLevel" : "error",
    "DiagnoseResultDescription" : "{\"targetIp\":\"192.168.0.1\",\"srcIp\":\"192.168.1.1\",\"rtt\":-1.0,\"lossRate\":100.0}",
    "DiagnoseName" : "VcoPrivateConnectivity"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 VpnGateway.Configuring The specified service is configuring. 服务正在配置中,请您稍后再试。
403 Forbidden User not authorized to operate on the specified resource. 您没有权限操作指定资源,请申请权限后再操作。
404 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist. 指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。

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