GetVpnGatewayDiagnoseResult - VPN Gateway - Alibaba Cloud ドキュメントセンター

GetVpnGatewayDiagnoseResult 操作を呼び出して、VPN ゲートウェイインスタンスのワンクリック診断結果を照会します。

操作説明

GetVpnGatewayDiagnoseResult 操作を呼び出す際、必須パラメーターに加えて、DiagnoseId と VpnGatewayId パラメーターの少なくとも 1 つを指定する必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:GetVpnGatewayDiagnoseResult

get

*VpnGateway

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	VPN ゲートウェイインスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、リージョン ID をクエリできます。	cn-qingdao
DiagnoseId	string	任意	診断 ID。診断 ID は、 DiagnoseVpnGateway 操作を呼び出した際に返されます。	vpndgn-uf6kuxbe3iv028k3s****
VpnGatewayId	string	任意	VPN ゲートウェイインスタンス ID。	vpn-uf6fzwp0ck3frwtbk****
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId をクライアントトークンとして使用します。RequestId は API リクエストごとに異なる場合があります。	02fb3da4-130e-11e9-8e44-001****

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
BeginTime	string	診断が開始された時間。時間は協定世界時 (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-VPN 接続クォータ。 VpnPbrRouteQuota: VPN ゲートウェイのポリシーベースルートクォータ。 VcoConfigConsistency: IPsec 構成の整合性。 VcoUserInternetIpConnectivity: カスタマーゲートウェイのパブリック接続性。 VcoPrivateConnectivity: プライベートネットワーク接続性。各診断項目の詳細については、ワンクリック診断バックグラウンド情報を参照してください。	RouteEntryConflict
DiagnoseResultDescription	string	診断項目の診断結果。操作は診断項目ごとに異なる情報を返します: RouteEntryConflict: システムはルートの競合に関する情報を返します。 VpnRouteQuota: quotaName: 送信先ルートクォータの ID。 quantity: 現在の VPN ゲートウェイインスタンスがサポートする送信先ルートの数量。 used: 現在の VPN ゲートウェイインスタンスに作成済みの送信先ルートの数量。 VpnIPsecQuota: quotaName: IPsec-VPN 接続クォータの ID。 quantity: 現在の VPN ゲートウェイインスタンスがサポートする IPsec-VPN 接続数。 used: 現在の VPN ゲートウェイインスタンスに作成済みの IPsec-VPN 接続数。 VpnPbrRouteQuota: quotaName: ポリシーベースルートクォータの ID。 quantity: 現在の VPN ゲートウェイインスタンスがサポートするポリシーベースルートの数量。 used: 現在の VPN ゲートウェイインスタンスに作成済みのポリシーベースルートの数量。 VcoConfigConsistency: vcoLackConf: システムは IPsec-VPN 接続のピア側の構成を取得できません。 vcoRunningConf: IPsec-VPN 接続のピア側に追加済みの構成。 vcoDiffConf: IPsec-VPN 接続のローカル側とピア側で不整合な構成のリスト。 vcoConf: IPsec-VPN 接続のローカル側に追加済みの構成。 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	診断が終了した時間。時間は協定世界時 (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-VPN 接続を示します。	IPsec
TotalCount	integer	診断項目の合計数。	7
VpnGatewayId	string	VPN ゲートウェイインスタンス ID。	vpn-uf6fzwp0ck3frwtbk****

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。