DescribeDBLinks API Reference for PolarDB Database Links - PolarDB - Alibaba Cloud - PolarDB

Operation description

Note

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeDBLinks

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	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*************
DBLinkName	string	No	The name of the database link. If you leave this parameter empty, the system returns all the database links.	dblink_test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	45D24263-7E3A-4140-9472-************
DBLinkInfos	array<object>	Details about the database links.
	object
DBInstanceName	string	The ID of the source cluster that the database link connects.	pc-a*************
DBLinkName	string	The name of the database link.	dblink_test
SourceDBName	string	The name of the source database of the database link.	testdb1
TargetDBName	string	The name of the destination database of the database link.	testdb2
TargetDBInstanceName	string	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************
TargetAccount	string	The account of the destination database of the database link.	testacc
DBInstanceName	string	The ID of the cluster.	pc-a*************

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.