All Products
Search
Document Center

PolarDB:DescribeDBLinks

Last Updated:Nov 07, 2023

Queries the database links of a PolarDB for PostgreSQL (Compatible with Oracle) cluster.

Operation Description

Note You can query only the database links that use a PolarDB for Oracle cluster as the source.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeDBLinksREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster for which you want to query the database links.

Note You can call the DescribeDBClusters operation to query PolarDB clusters.
pc-a*************
DBLinkNamestringNo

The name of the database link. If you leave this parameter empty, the system returns all the database links.

dblink_test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

45D24263-7E3A-4140-9472-************
DBLinkInfosobject []

Details about the database links.

DBInstanceNamestring

The ID of the source cluster that the database link connects.

pc-a*************
DBLinkNamestring

The name of the database link.

dblink_test
SourceDBNamestring

The name of the source database of the database link.

testdb1
TargetDBNamestring

The name of the destination database of the database link.

testdb2
TargetDBInstanceNamestring

The ID of the destination cluster that the database link connects.

Note If the destination cluster is not a PolarDB for Oracle cluster, the returned value is empty.
pc-b************
TargetAccountstring

The account of the destination database of the database link.

testacc
DBInstanceNamestring

The ID of the cluster.

pc-a*************

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.