創建DBLink。
接口說明
DBLink 可以連接兩個 PolarDB PostgreSQL 版(兼容 Oracle)集群,也可以連接 PolarDB PostgreSQL 版(兼容 Oracle)集群和 ECS 自建 PostgreSQL 數據庫。您可以通過 DBLink 跨集群查詢數據。
說明
一個集群最多可創建 10 條 DBLink。
DBLink 的源集群和目標集群均會占用自身 1 條 DBLink。
源集群與目標集群或目標 ECS 必須位于同一個地域。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
polardb:CreateDBLink | Write |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceGroupId | string | 否 | 資源組 ID。 | rg-************ |
DBClusterId | string | 是 | DBLink 的源集群 ID。 說明
您可以通過 DescribeDBClusters 接口查看 PolarDB 集群列表。
| pc-a************ |
DBLinkName | string | 是 | DBLink 名稱。
| dblink_test |
TargetDBInstanceName | string | 是 | DBLink 的目標集群 ID。 說明
null 。 | pc-b************ |
TargetDBAccount | string | 是 | 目標數據庫賬號。 說明
您可以通過 DescribeAccounts 接口查看 PolarDB 集群的數據庫賬號。
| testacc |
TargetDBPasswd | string | 是 | 目標數據庫賬號的密碼。 | Test1111 |
TargetDBName | string | 是 | 目標數據庫名稱。 說明
您可以通過 DescribeDatabases 接口查詢 PolarDB 集群中的數據庫信息。
| testdb2 |
SourceDBName | string | 是 | 源數據庫名稱。 說明
您可以通過 DescribeDatabases 接口查詢 PolarDB 集群中的數據庫信息。
| testdb1 |
TargetIp | string | 否 | ECS 自建 Oracle 數據庫的 IP 地址。 | 192.**.**.46 |
TargetPort | string | 否 | ECS 自建 Oracle 數據庫的端口號。 | 1521 |
VpcId | string | 否 | VPC ID。 說明
可通過接口 DescribeVpcs 查看 VPC 信息詳情。
| vpc-bp1qpo0kug3a20qqe**** |
RegionId | string | 否 | 地域 ID。 說明
可通過接口 DescribeRegions 查看地域信息詳情。
| cn-hangzhou |
ClientToken | string | 否 | 用于保證請求的冪等性,防止重復提交請求。由客戶端生成該參數值,保證在不同請求間唯一,大小寫敏感、不超過 64 個 ASCII 字符。 | 6000170000591aed949d0f54a343f1a4233c1e7d1c5c****** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "F9F1CB1A-B1D5-4EF5-A53A-************"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidDBLinkName.Malformed | The specified parameter DBLinkName is not valid. | 指定的參數DBLinkName無效。 |
404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 當前的記錄中不存在提供的 DBClusterId。 |
404 | DBLinkSourceDBNotFound | Specified source db does not exist. | 指定的源數據庫不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2023-09-12 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||
|