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

指定された VPN ゲートウェイインスタンスに対してワンクリック診断を実行します。

操作説明

特定のリージョンの VPN ゲートウェイインスタンスのみがワンクリック診断の特徴をサポートしています。リージョンの詳細については、「VPN Gateway の特徴をサポートするリージョン」をご参照ください。

今すぐお試しください

この 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:DiagnoseVpnGateway

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	VPN ゲートウェイインスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、リージョン ID をクエリできます。	cn-qingdao
ResourceId	string	必須	診断対象のリソースの ID。	vco-uf66xniofskqtuoz1****
ResourceType	string	必須	診断対象のリソースのタイプ。値は IPsec のみで、IPsec-VPN 接続を示します。	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	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。ClientToken の値には ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は各 API 呼び出しで異なる場合があります。	02fb3da4-130e-11e9-8e44-001****

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
DiagnoseId	string	診断 ID。この操作が診断 ID を返した後、 GetVpnGatewayDiagnoseResult 操作を呼び出して診断レポートをクエリできます。	vpndgn-uf6kuxbe3iv028k3s****
RequestId	string	リクエストの ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
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.	EIP が現在の呼び出し元に属していません。この EIP を操作する権限があるかどうかを確認してください。
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.
404	InvalidResourceId.NotFound	The specified resource id [%s] does not exist.

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

変更履歴

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