GetVpnGatewayDiagnoseResult - VPN Gateway

調用GetVpnGatewayDiagnoseResult介面查詢VPN閘道執行個體的一鍵診斷結果。

介面說明

調用 GetVpnGatewayDiagnoseResult 介面時，除必填參數外，DiagnoseId 和 VpnGatewayId 參數需至少輸入一個。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:GetVpnGatewayDiagnoseResult

get

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnInstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	VPN 閘道執行個體所屬的地域 ID。您可以透過調用 DescribeRegions 介面取得地域 ID。	cn-qingdao
DiagnoseId	string	否	診斷 ID。在您調用 DiagnoseVpnGateway 介面時，系統會返回對應的診斷 ID。	vpndgn-uf6kuxbe3iv028k3s****
VpnGatewayId	string	否	VPN 閘道執行個體 ID。	vpn-uf6fzwp0ck3frwtbk****
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	02fb3da4-130e-11e9-8e44-001****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
BeginTime	string	診斷開始的時間。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mm:ssZ`。	2022-12-15T05:28:57Z
DiagnoseId	string	診斷 ID。	vpndgn-uf6sgneym02lxyuv4****
DiagnoseResult	array<object>	診斷項資訊列表。
	object	診斷項資訊。
DiagnoseName	string	診斷項。 RouteEntryConflict：路由衝突。 VpnRouteQuota：VPN 閘道目的路由配額。 VpnIPsecQuota：VPN 閘道 IPsec 連線配額。 VpnPbrRouteQuota：VPN 閘道策略路由配額。 VcoConfigConsistency：IPsec 設定一致性。 VcoUserInternetIpConnectivity：使用者閘道公網連通性。 VcoPrivateConnectivity：私網連通性。關於每個診斷項的說明資訊，請參見一鍵診斷背景資訊。	RouteEntryConflict
DiagnoseResultDescription	string	診斷項的診斷結果。針對每個診斷項，介面會返回不同的資訊，說明如下： 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}
DiagnoseResultLevel	string	診斷項的診斷結果級別。 normal：正常。 warning：警告。 error：異常。關於每個診斷項對應的每個診斷結果級別的說明，請參見一鍵診斷背景資訊。	normal
FinishTime	string	診斷結束的時間。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mm:ssZ`。	2022-12-15T05:29:08Z
FinishedCount	integer	已完成診斷的診斷項數量。	7
RequestId	string	請求 ID。	312C4D5A-6563-5FC6-8C6E-A43A5A316FEB
ResourceInstanceId	string	診斷的資源 ID。	vco-uf6huqsu63azl7mdp****
ResourceType	string	診斷的資源類型。取值：IPsec，表示 IPsec 連線。	IPsec
TotalCount	integer	診斷項總數。	7
VpnGatewayId	string	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	錯誤碼	錯誤資訊
400	param_error	The param is must be in ...
400	MissingParam.DiagnoseInfo	The VPN gateway ID and diagnose ID cannot be empty at the same time.
400	VpnGateway.Configuring	The specified service is configuring.
400	IncorrectStatus.DiagnoseTimeout	Diagnose failed because of timeout.
400	IncorrectStatus.VpnConnectionDeleted	Diagnose failed because the VPN connection has been deleted.
403	Forbidden	User not authorized to operate on the specified resource.
404	InvalidDiagnoseId.NotFound	The specified diagnose ID [%s] does not exist.
404	InvalidVpnGatewayId.NotFound	The specified VPN gateway [%s] does not have any diagnoses.
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。