调用DescribeDBLinks查询集群DBLink信息_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询PolarDB PostgreSQL版（兼容Oracle）集群的DBLink信息。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeDBLinks	Read	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	object []	DBLink 信息集。
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。

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