使用CreateDBLink API实现跨集群数据查询-云原生数据库 PolarDB-阿里云

创建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

create

*DBCluster

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

无

请求参数

名称	类型	必填	描述	示例值
ResourceGroupId	string	否	资源组 ID。	rg-************
DBClusterId	string	是	DBLink 的源集群 ID。说明您可以通过 DescribeDBClusters 接口查看 PolarDB 集群列表。	pc-a************
DBLinkName	string	是	DBLink 名称。由小写字母、数字、下划线（_）其中一到三种组成，必须包含小写字母。以字母开头，字母或数字结尾。长度不超过 64 个字符。	dblink_test
TargetDBInstanceName	string	否	DBLink 的目标集群 ID。说明如果目标为 ECS 自建 Oracle 数据库，该参数请传入`null`。您可以通过 DescribeDBClusters 接口查看 PolarDB 集群列表。	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******

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	F9F1CB1A-B1D5-4EF5-A53A-************

示例

正常返回示例

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.	指定的源数据库不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。