All Products
Search
Document Center

AnalyticDB:CreateApsDatasoure

Last Updated:Nov 03, 2025

Creates an AnalyticDB Pipeline Service (APS) data source.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

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
adb:CreateApsDatasourenone
*DBClusterLakeVersion
acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

amv-xxxxx
RegionIdstringYes

The region ID.

cn-shanghai
DatasourceTypestringYes

The type of the data source.

KAFKA
DatasourceNamestringYes

The name of the data source.

sls-******
DatasourceDescriptionstringNo

The description of the data source.

description
ModestringNo

The mode.

ALI_CLOUD_INSTANCE
SlsInfoobjectNo

The information about the source Simple Log Service (SLS) instance or cluster.

SourceRegionIdstringNo

The region ID.

cn-beijing
ProjectstringNo

The SLS project.

test-project
StorestringNo

The name of the SLS Logstore.

test-store
AcrossbooleanNo

Specifies whether the data source is a cross-account resource.

false
AcrossUidstringNo

The cross-account UID.

xxxx
AcrossRolestringNo

The name of the cross-account role.

yyy
KafkaInfoobjectNo

The information about the source Apache Kafka instance.

KafkaClusterIdstringNo

The ID of the Apache Kafka instance.

******
KafkaTopicstringNo

The topic of the Apache Kafka instance.

test
HiveInfoobjectNo

The information about the Hive data source.

MetaStoreUristringNo

The URL of the Hive Metastore.

******
VswitchstringNo

The vSwitch ID.

vsw-bp1*****k
SecurityGroupstringNo

The security group ID.

sg-uf*******h
ClusterIdstringNo

The cluster ID.

******
HostConfigstringNo

The configuration of the host.

******
RdsMysqlInfoobjectNo

The information about the source ApsaraDB RDS for MySQL instance.

InstanceIdstringNo

The instance ID.

rm-xxxxxxx
UserNamestringNo

The name of the database account of the instance.

user
PasswordstringNo

The password of the database account of the instance.

******
RegionIdstringNo

The region ID.

cn-shanghai
ConnectUrlstringNo

The URL used to connect to the read-only instance.

******
SecurityGroupstringNo

The security group ID.

sg-******
PolarDBMysqlInfoobjectNo

The information about the source PolarDB for MySQL cluster.

InstanceIdstringNo

The instance ID.

pc-bp*********
UserNamestringNo

The username used to access the instance.

test-user-name
PasswordstringNo

The password.

***
RegionIdstringNo

The region ID.

cn-shanghai
ConnectUrlstringNo

The URL used to connect to the custom ApsaraDB RDS for MySQL instance.

****
SecurityGroupstringNo

The security group ID.

sg-******
AcrossbooleanNo

Specifies whether the data source is a cross-account resource. Valid values:

  • true
  • false
false
AcrossUidstringNo

The cross-account UID.

123456789*
AcrossRolestringNo

The name of the cross-account role.

test-role
PolarDBXInfoobjectNo

The information about the source PolarDB-X instance.

InstanceIdstringNo

The instance ID.

-
DatabricksInfoobjectNo

The information about the Databricks data source.

AccessTokenstringNo

The token that is used to access Databricks.

******
WorkspaceURLstringNo

The URL of the workspace.

xxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The response code. The status code 200 indicates that the request was successful.

200
Datastring

The information about the cluster resource usage.

69
RequestIdstring

The request ID.

65D2***-45C1-5C18-**********
Successboolean

Indicates whether the dry run succeeds. Valid values:

  • true
  • false
True
Codestring

The HTTP status code or the error code.

200
Messagestring

The returned message. Valid values:

  • If the request was successful, a success message is returned.****
  • If the request failed, an error message is returned.
OK
DBClusterIdstring

The cluster ID.

amv-7xxxxx

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": 69,
  "RequestId": "65D2***-45C1-5C18-**********",
  "Success": true,
  "Code": 200,
  "Message": "OK",
  "DBClusterId": "amv-7xxxxx"
}

Error codes

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