全部产品
Search

搜索本产品

    VPN网关：DiagnoseVpnGateway - 一键诊断指定的VPN网关实例

    文档中心

    VPN网关：DiagnoseVpnGateway - 一键诊断指定的VPN网关实例

    更新时间：Aug 07, 2026

    调用DiagnoseVpnGateway接口一键诊断指定的VPN网关实例。

    接口说明

    仅部分地域下的 VPN 网关实例支持一键诊断功能。关于地域的更多信息，请参见 VPN 网关功能支持的地域。

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    vpc:DiagnoseVpnGateway

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    RegionId

    string

    是

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

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

    cn-qingdao
    ResourceId

    string

    是

    待诊断的资源 ID。

    vco-uf66xniofskqtuoz1****
    ResourceType

    string

    是

    待诊断的资源类型。

    仅取值：IPsec，表示 IPsec 连接。

    IPsec
    VpnGatewayId

    string

    是

    VPN 网关实例 ID。

    vpn-m5efhj0k1p47ctuhl****
    IPsecExtendInfo

    string

    否

    检查指定地址间的私网连通性。取值：

    • PrivateSourceIp：源 IP 地址。源 IP 地址需为 VPC 侧的地址。

    • PrivateDestinationIp：目的 IP 地址。目的 IP 地址需为本地数据中心侧的地址。

    {"PrivateSourceIp":"192.168.1.1","PrivateDestinationIp":"192.168.0.1"}
    ClientToken

    string

    否

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

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

    说明

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

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

    返回参数

    名称

    类型

    描述

    示例值

    object

    返回结果。

    DiagnoseId

    string

    诊断 ID。

    当前接口返回诊断 ID 后，您可以调用 GetVpnGatewayDiagnoseResult 接口查询诊断报告。

    vpndgn-uf6kuxbe3iv028k3s****
    RequestId

    string

    请求 ID。

    0ED8D006-F706-4D23-88ED-E11ED28DCAC0

    示例

    正常返回示例

    JSON格式

    {
  "DiagnoseId": "vpndgn-uf6kuxbe3iv028k3s****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
    400 VpnGateway.Configuring The specified service is configuring.
    400 OperationUnsupported.DiagnoseVpn Current version of the VPN does not support diagnose.
    400 IllegalParam.ResourceType The specified resource type [%s] is invalid.
    400 OperationFailed.VpnGatewayDiagnosing The VPN gateway is diagnosing.
    400 OperationFailed.StartDiagnose Start VPN gateway diagnose failed.
    400 IllegalParam.PrivateSourceIp The specified private source IP [%s] is invalid.
    400 IllegalParam.PrivateDestinationIp The specified private destination IP [%s] is invalid.
    403 Forbidden User not authorized to operate on the specified resource. 您没有权限操作指定资源，请申请权限后再操作。
    404 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist.
    404 InvalidResourceId.NotFound The specified resource id [%s] does not exist.

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

    变更历史

    更多信息，参考变更详情。