CreateDBLink-阿里云帮助中心

DBLink可以连接两个PolarDB O引擎集群，也可以连接PolarDB O引擎集群和ECS自建PostgreSQL数据库。您可以通过DBLink跨集群查询数据。

说明

一个集群最多可创建10条DBLink。
DBLink的源集群和目标集群均会占用自身1条DBLink。
源集群与目标集群或目标ECS必须位于同一个地域。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	CreateDBLink	系统规定参数。取值：CreateDBLink。
DBClusterId	String	是	pc-a************	DBLink的源集群ID。说明您可以通过DescribeDBClusters接口查看PolarDB集群列表。
DBLinkName	String	是	dblink_test	DBLink名称。由小写字母、数字、下划线（_）其中一到三种组成，必须包含小写字母。以字母开头，字母或数字结尾。长度不超过64个字符。
TargetDBInstanceName	String	是	pc-b************	DBLink的目标集群ID。说明如果目标为ECS自建Oracle数据库，该参数请传入`null`。您可以通过DescribeDBClusters接口查看PolarDB集群列表。
TargetDBAccount	String	是	testacc	目标数据库账号。说明您可以通过DescribeAccounts接口查看PolarDB集群的数据库账号。
TargetDBPasswd	String	是	Test1111	目标数据库账号的密码。
TargetDBName	String	是	testdb2	目标数据库名称。说明您可以通过DescribeDatabases接口查询PolarDB集群中的数据库信息。
SourceDBName	String	是	testdb1	源数据库名称。说明您可以通过DescribeDatabases接口查询PolarDB集群中的数据库信息。
TargetIp	String	否	192...46	ECS自建Oracle数据库的IP地址。
TargetPort	String	否	1521	ECS自建Oracle数据库的端口号。
VpcId	String	否	vpc-bp1qpo0kug3a20qqe****	VPC ID。说明可通过接口DescribeVpcs查看VPC信息详情。
RegionId	String	否	cn-hangzhou	地域ID。说明可通过接口DescribeRegions查看地域信息详情。
ClientToken	String	否	6000170000591aed949d0f54a343f1a4233c1e7d1c5c******	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。

返回数据


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

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=CreateDBLink
&DBClusterId=pc-a************
&DBLinkName=dblink_test
&TargetDBInstanceName=pc-b************
&TargetDBAccount=testacc
&TargetDBPasswd=Test1111
&TargetDBName=testdb2
&SourceDBName=testdb1
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDBLinkResponse>
    <RequestId>F9F1CB1A-B1D5-4EF5-A53A-************</RequestId>
</CreateDBLinkResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "F9F1CB1A-B1D5-4EF5-A53A-************"
}

错误码

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