All Products
Search
Document Center

AnalyticDB:CreateRemoteADBDataSource

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.

Create Homogeneous Data 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.

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:CreateRemoteADBDataSourcecreate
*DBInstance
acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LocalDBInstanceIdstringYes

Instance ID of the data being used (required).

gp-test1
LocalDatabasestringYes

Database name of the data being used (required)

db1
RemoteDBInstanceIdstringYes

Instance ID providing the data (required).

gp-test2
RemoteDatabasestringYes

Database name providing the data (required).

db2
UserNamestringYes

Account name of the data-providing instance used for user mapping (required).

account1
UserPasswordstringYes

Password of the data-providing instance account used for user mapping.

password1
ManagerUserNamestringYes

Management account of the data-using instance.

managerAccount
ManagerUserPasswordstringYes

Password of the management account of the data-using instance.

password2
DataSourceNamestringNo

Customer-specified DataSourceName.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

e9d60eb1-e90d-4bc6-a470-c8b767460858
TaskIdinteger

Workflow task ID.

90000
DataSourceItemobject

Returns the successfully added data sharing service data.

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

Management account user name

manager_user
Statusstring

Synchronization status

creating
Descriptionstring

Description information.

userName
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,
  "DataSourceItem": {
    "Id": 1,
    "DataSourceName": "db1_gptest1_to_db2_gp-test2",
    "LocalInstanceName": "gp-test1",
    "LocalDatabase": "db1",
    "RemoteInstanceName": "gp-test2",
    "RemoteDatabase": "db2",
    "UserName": "user1",
    "ManagerUserName": "manager_user",
    "Status": "creating",
    "Description": "userName",
    "RegionId": "cn-beijing"
  }
}

Error codes

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