すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeDbInstanceConnectivity

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeDbInstanceConnectivity

    最終更新日:Mar 30, 2026

    クライアント IP アドレスとインスタンス間の接続性を確認します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    kvstore:DescribeDbInstanceConnectivity

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンスの ID。

    r-bp1r36hdqlrgt1****
    SrcIp

    string

    必須

    クライアントの IP アドレス。

    124.207.240.***

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ。

    RequestId

    string

    リクエストの ID。

    2BE6E619-A657-42E3-AD2D-18F8428A****
    ConnCheckResult

    string

    接続チェック結果。有効な値は次のとおりです。

    • Success

    • Failed

    Failed
    ConnCheckErrorCode

    string

    接続診断のエラーコード。有効な値は次のとおりです。

    • SRC_IP_NOT_IN_USER_WHITELIST: ソース IP アドレスはホワイトリストに追加されていません。

    • CONNECTION_ABNORMAL: インスタンスへの接続は正常です。

    SRC_IP_NOT_IN_USER_WHITELIST
    ConnCheckErrorMessage

    string

    接続診断のエラーメッセージ。

    Src ip:172.28.134.96 not in user whitelist

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "2BE6E619-A657-42E3-AD2D-18F8428A****",
  "ConnCheckResult": "Failed",
  "ConnCheckErrorCode": "SRC_IP_NOT_IN_USER_WHITELIST",
  "ConnCheckErrorMessage": "Src ip:172.28.134.96 not in user whitelist"
}

    エラーコード

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

    変更履歴

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