Creates an AnalyticDB Pipeline Service (APS) data source.
Operation description
For information about the endpoints of AnalyticDB for MySQL, see Endpoints .
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| adb:CreateApsDatasoure | none | *DBClusterLakeVersion acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | The cluster ID. | amv-xxxxx |
| RegionId | string | Yes | The region ID. | cn-shanghai |
| DatasourceType | string | Yes | The type of the data source. | KAFKA |
| DatasourceName | string | Yes | The name of the data source. | sls-****** |
| DatasourceDescription | string | No | The description of the data source. | description |
| Mode | string | No | The mode. | ALI_CLOUD_INSTANCE |
| SlsInfo | object | No | The information about the source Simple Log Service (SLS) instance or cluster. | |
| SourceRegionId | string | No | The region ID. | cn-beijing |
| Project | string | No | The SLS project. | test-project |
| Store | string | No | The name of the SLS Logstore. | test-store |
| Across | boolean | No | Specifies whether the data source is a cross-account resource. | false |
| AcrossUid | string | No | The cross-account UID. | xxxx |
| AcrossRole | string | No | The name of the cross-account role. | yyy |
| KafkaInfo | object | No | The information about the source Apache Kafka instance. | |
| KafkaClusterId | string | No | The ID of the Apache Kafka instance. | ****** |
| KafkaTopic | string | No | The topic of the Apache Kafka instance. | test |
| HiveInfo | object | No | The information about the Hive data source. | |
| MetaStoreUri | string | No | The URL of the Hive Metastore. | ****** |
| Vswitch | string | No | The vSwitch ID. | vsw-bp1*****k |
| SecurityGroup | string | No | The security group ID. | sg-uf*******h |
| ClusterId | string | No | The cluster ID. | ****** |
| HostConfig | string | No | The configuration of the host. | ****** |
| RdsMysqlInfo | object | No | The information about the source ApsaraDB RDS for MySQL instance. | |
| InstanceId | string | No | The instance ID. | rm-xxxxxxx |
| UserName | string | No | The name of the database account of the instance. | user |
| Password | string | No | The password of the database account of the instance. | ****** |
| RegionId | string | No | The region ID. | cn-shanghai |
| ConnectUrl | string | No | The URL used to connect to the read-only instance. | ****** |
| SecurityGroup | string | No | The security group ID. | sg-****** |
| PolarDBMysqlInfo | object | No | The information about the source PolarDB for MySQL cluster. | |
| InstanceId | string | No | The instance ID. | pc-bp********* |
| UserName | string | No | The username used to access the instance. | test-user-name |
| Password | string | No | The password. | *** |
| RegionId | string | No | The region ID. | cn-shanghai |
| ConnectUrl | string | No | The URL used to connect to the custom ApsaraDB RDS for MySQL instance. | **** |
| SecurityGroup | string | No | The security group ID. | sg-****** |
| Across | boolean | No | Specifies whether the data source is a cross-account resource. Valid values:
| false |
| AcrossUid | string | No | The cross-account UID. | 123456789* |
| AcrossRole | string | No | The name of the cross-account role. | test-role |
| PolarDBXInfo | object | No | The information about the source PolarDB-X instance. | |
| InstanceId | string | No | The instance ID. | - |
| DatabricksInfo | object | No | The information about the Databricks data source. | |
| AccessToken | string | No | The token that is used to access Databricks. | ****** |
| WorkspaceURL | string | No | The URL of the workspace. | xxxxx |
Response parameters
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.
