All Products
Search
Document Center

AnalyticDB:ListRemoteADBDataSources

Last Updated:Nov 05, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries remote AnalyticDB data sources.

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
gpdb:ListRemoteADBDataSourceslist
*DBInstance
acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

Instance name.

gp-xxxx
DataSourceIdstringNo

Data source ID.

119

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

e9d60eb1-e90d-4bc6-a470-c8b767460858
TaskIdinteger

Task ID.

90000
DataSourceItemsarray<object>

Returns the successfully added data sharing service data.

RemoteDataSourcesobject
Idlong

ID.

1
DataSourceNamestring

Data source name

db1_gptest1_to_db2_gp-test2
LocalInstanceNamestring

Local instance name

gp-test1
LocalDatabasestring

Local database name

db1
RemoteInstanceNamestring

Remote instance name

gp-test2
RemoteDatabasestring

Remote database name

db2
UserNamestring

User name

user1
ManagerUserNamestring

Manager user name

admin
Statusstring

Data source status

creating
Descriptionstring

Description.

test
RegionIdstring

Region ID.

Note You can call the DescribeRegions API to view available region IDs.
cn-beijing

Examples

Sample success responses

JSONformat

{
  "RequestId": "e9d60eb1-e90d-4bc6-a470-c8b767460858",
  "TaskId": 90000,
  "DataSourceItems": {
    "RemoteDataSources": [
      {
        "Id": 1,
        "DataSourceName": "db1_gptest1_to_db2_gp-test2",
        "LocalInstanceName": "gp-test1",
        "LocalDatabase": "db1",
        "RemoteInstanceName": "gp-test2",
        "RemoteDatabase": "db2",
        "UserName": "user1",
        "ManagerUserName": "admin",
        "Status": "creating",
        "Description": "test",
        "RegionId": "cn-beijing"
      }
    ]
  }
}

Error codes

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