すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribeDBClusterConnectivity

最終更新日:Apr 10, 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeDBClusterConnectivity

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ResourceGroupId

string

任意

リソースグループの ID。

rg-************

DBClusterId

string

必須

クラスター ID。

pc-xxxxxxxxxxxxx

SourceIpAddress

string

必須

ソース IP アドレス。

192.***.***.1

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

73A85BAF-1039-4CDE-A83F-1A140F******

DBClusterId

string

クラスター ID。

pc-xxxxxxxxxxxxx

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:192.***.***.1 not in user whitelist

成功レスポンス

JSONJSON

{
  "RequestId": "73A85BAF-1039-4CDE-A83F-1A140F******",
  "DBClusterId": "pc-xxxxxxxxxxxxx",
  "ConnCheckResult": "Failed",
  "ConnCheckErrorCode": "SRC_IP_NOT_IN_USER_WHITELIST",
  "ConnCheckErrorMessage": "Src ip:192.***.***.1 not in user whitelist"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidAction Specified action is not valid.

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

変更履歴

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