调用DescribeDBLinks接口查询PolarDB PostgreSQL版（兼容Oracle）集群的DBLink信息。

说明 目前仅支持查询以PolarDB PostgreSQL版（兼容Oracle）集群为源的DBLink信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDBLinks

系统规定参数。取值：DescribeDBLinks。
DBClusterId String 是 pc-a*************

需要查询DBLink的集群ID。

说明 您可以通过DescribeDBClusters接口查看PolarDB集群列表。
DBLinkName String 否 dblink_test

DBLink名称。不传则返回所有DBLink。

返回数据

名称 类型 示例值 描述
RequestId String 45D24263-7E3A-4140-9472-************

请求ID。
DBLinkInfos Array of DBLinkInfos

DBLink信息集。
DBInstanceName String pc-a*************

DBLink的源集群ID。
DBLinkName String dblink_test

DBLink名称。
SourceDBName String testdb1

DBLink的源数据库名称。
TargetDBName String testdb2

DBLink的目标数据库名称。
TargetDBInstanceName String pc-b************

DBLink的目标集群ID。

说明 如果目标不是PolarDB PostgreSQL版（兼容Oracle）集群，则该参数为空。
TargetAccount String testacc

DBLink的目标数据库账号。
DBInstanceName String pc-a*************

集群ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBLinks
&DBClusterId=pc-*************
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeDBLinksResponse>
    <RequestId>45D24263-7E3A-4140-9472-7C1BE3B1F19A</RequestId>
    <DBLinkInfos>
        <SourceDBName>testdb1</SourceDBName>
        <TargetDBName>testdb2</TargetDBName>
        <TargetAccount>testacc</TargetAccount>
        <TargetDBInstanceName>pc-b************</TargetDBInstanceName>
        <DBInstanceName>pc-a*************</DBInstanceName>
        <DBLinkName>dblink_test</DBLinkName>
    </DBLinkInfos>
</DescribeDBLinksResponse>

JSON格式

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

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

错误码

HttpCode 错误码 错误信息 描述
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。

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