調用DescribeDBLinks查詢叢集DBLink資訊-雲原生資料庫 PolarDB-阿里雲

介面說明

說明

目前僅支援查詢以 PolarDB PostgreSQL 版（相容 Oracle）叢集為源的 DBLink 資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeDBLinks

get

*dbcluster

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	需要查詢 DBLink 的叢集 ID。說明您可以通過 DescribeDBClusters 介面查看 PolarDB 叢集列表。	pc-a*************
DBLinkName	string	否	DBLink 名稱。不傳則返回所有 DBLink。	dblink_test

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	45D24263-7E3A-4140-9472-************
DBLinkInfos	array<object>	DBLink 資訊集。
	object
DBInstanceName	string	DBLink 的源叢集 ID。	pc-a*************
DBLinkName	string	DBLink 名稱。	dblink_test
SourceDBName	string	DBLink 的來源資料庫名稱。	testdb1
TargetDBName	string	DBLink 的目標資料庫名稱。	testdb2
TargetDBInstanceName	string	DBLink 的目的地組群 ID。說明如果目標不是 PolarDB PostgreSQL 版（相容 Oracle）叢集，則該參數為空白。	pc-b************
TargetAccount	string	DBLink 的目標資料庫帳號。	testacc
DBInstanceName	string	叢集 ID。	pc-a*************

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的DBClusterId。
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的 DBClusterId。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。