PolarDB データベースリンク向け DescribeDBLinks API リファレンス - PolarDB

操作説明

説明

PolarDB for Oracle クラスターをソースとして使用するデータベースリンクのみをクエリできます。

今すぐお試しください

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

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	データベースリンクをクエリするクラスターの ID。説明 DescribeDBClusters 操作を呼び出して、PolarDB クラスターをクエリできます。	pc-a*************
DBLinkName	string	任意	データベースリンクの名前。このパラメーターを空のままにすると、システムはすべてのデータベースリンクを返します。	dblink_test

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	45D24263-7E3A-4140-9472-************
DBLinkInfos	array<object>	データベースリンクの詳細。
	object
DBInstanceName	string	データベースリンクが接続するソースクラスターの ID。	pc-a*************
DBLinkName	string	データベースリンクの名前。	dblink_test
SourceDBName	string	データベースリンクのソースデータベースの名前。	testdb1
TargetDBName	string	データベースリンクのターゲットデータベースの名前。	testdb2
TargetDBInstanceName	string	データベースリンクが接続するターゲットクラスターの ID。説明ターゲットクラスターが PolarDB for Oracle クラスターでない場合、返される値は空です。	pc-b************
TargetAccount	string	データベースリンクのターゲットデータベースのアカウント。	testacc
DBInstanceName	string	クラスターの ID。	pc-a*************

例

成功レスポンス

JSONJSON

{
  "RequestId": "45D24263-7E3A-4140-9472-************",
  "DBLinkInfos": [
    {
      "DBInstanceName": "pc-a*************",
      "DBLinkName": "dblink_test",
      "SourceDBName": "testdb1",
      "TargetDBName": "testdb2",
      "TargetDBInstanceName": "pc-b************",
      "TargetAccount": "testacc"
    }
  ],
  "DBInstanceName": "pc-a*************"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.

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

変更履歴

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