GetDBInstanceConnectivityDiagnosis API によるデータベースインスタンスのネットワーク接続診断 - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

ユーザー指定の IP アドレスから指定されたデータベースインスタンスへのネットワーク接続性診断結果を取得します。

操作説明

開始する前に:

最新バージョンの Alibaba Cloud SDK または DAS SDK を使用してください。
SDK を使用して DAS を呼び出す場合は、リージョンを cn-shanghai に設定してください。
データベースインスタンスが DAS に接続されていること。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hdm:GetDBInstanceConnectivityDiagnosis

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。	rm-2ze8g2am97624****
SrcIp	string	必須	ソース IP アドレス。	47.100.XX.XX

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
Code	string	返される状態コード。	200
Message	string	返されるメッセージ。説明リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Successful
Data	object	詳細。
instanceId	string	インスタンスの ID。	rm-2ze8g2am97624****
success	boolean	チェックが通過したかどうかを示します。有効な値: true: チェックが通過しました。 false: チェックが通過しませんでした。	false
failType	string	例外タイプ。有効な値: 0: ユーザーが発行を解決できる問題です。 1: 当直担当者が発行を解決する必要がある問題です。	0
connCheckErrorCode	string	外れ値検出項目。有効な値: SRC_IP_NOT_IN_USER_WHITELIST: ソース IP アドレスがユーザーホワイトリストに追加されていません。 VIP_NOT_EXISTS: VIP に対応する ALB インスタンスが存在しません。 RS_NOT_EXISTS: RS が正しくマウントされていません。 VIP_TUNNEL_ID_NOT_CONSISTENT: VPC タイプの VIP で使用されている TUNNEL ID が、VPC の実際の TUNNEL ID と一致しません。 VIP_VPC_CLOUD_INSTANCE_NOT_EXISTS: VPC タイプの VIP が存在しません。 VIP_IS_NOT_NGLB: VIP の NGLB パターンがシャットダウンされています。 CUSTINS_NOT_ASSOCIATE_ECS_SECURITY_GROUP: インスタンスがセキュリティグループに関連付けられていません。 SRC_IP_NOT_IN_USER_WHITELIST: ソース IP アドレスがユーザーホワイトリストに追加されていません。 SRC_IP_NOT_IN_ADMIN_WHITELIST: ソース IP アドレスが管理マシンホワイトリストに追加されていません。 SRC_IP_NOT_IN_ECS_SECURITY_GROUP: ソース IP アドレスがインスタンスに関連付けられたセキュリティグループに追加されていません。 VPC_INSTANCE_IP_NOT_WORKING_STATUS: VPC IP アドレスが異常な状態です。	SRC_IP_NOT_IN_USER_WHITELIST
connCheckErrorMessage	string	外れ値検出項目の詳細。	Src ip:47.100.XX.XX not in user ホワイトリスト
RequestId	string	リクエスト ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	リクエストが成功したかどうかを示します。有効な値: true: リクエストが成功しました。 false: リクエストが失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "instanceId": "rm-2ze8g2am97624****",
    "success": false,
    "failType": "0",
    "connCheckErrorCode": "SRC_IP_NOT_IN_USER_WHITELIST",
    "connCheckErrorMessage": "Src ip:47.100.XX.XX not in user whitelist"
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.	リクエストパラメーターが無効です。
403	NoPermission	You are not authorized to do this action.	この操作を実行する権限がありません。

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

変更履歴

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