Creates an AnalyticDB Pipeline Service (APS) job from Simple Log Service (SLS) to an AnalyticDB for MySQL Data Warehouse Edition cluster.
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:CreateApsSlsADBJob | none | *DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | The cluster ID. | amv-********* |
| RegionId | string | Yes | The region ID. | cn-hangzhou |
| PartitionSpecs | array<object> | No | The information about partition. | - |
| object | No | The information about partition. | - | |
| Columns | array<object> | Yes | The information about columns. | - |
| object | Yes | The information about columns. | ||
| Name | string | No | The name of the column. | id |
| MapName | string | No | The name of the mapping. | test |
| Type | string | No | The data type of the column. | bigint |
| MapType | string | No | The type of the mapping. | int |
| PrimaryKeyDefinition | string | No | The definition of the primary key. | - |
| WorkloadName | string | Yes | The name of the workload. | sls-****** |
| LakehouseId | long | No | The lakehouse ID. | 123 |
| ResourceGroup | string | No | The name of the resource group. | test |
| AdvancedConfig | string | No | The advanced configurations. | - |
| HudiAdvancedConfig | string | No | The advanced configurations of Hudi. | - |
| FullComputeUnit | string | No | The number of full AnalyticDB compute units (ACUs). | 16 |
| IncrementalComputeUnit | string | No | The number of increment ACUs. | 168 |
| Project | string | No | The name of the SLS project. | test |
| Store | string | No | The SLS Logstore. | test |
| StartingOffsets | string | Yes | The start offset. | test |
| MaxOffsetsPerTrigger | long | No | The latest offset. | - |
| DbName | string | Yes | The name of the database. | dbName |
| TableName | string | Yes | The name of the table. | test |
| OutputFormat | string | No | The format of the output file. | - |
| TargetType | string | No | The destination type. | ADB |
| TargetGenerateRule | string | No | The rules for generating the destination database. | - |
| AcrossUid | string | No | The cross-account UID. | 123456 |
| AcrossRole | string | No | The name of the cross-account role. | test-role |
| OssLocation | string | No | The Object Storage Service (OSS) URL. | oss://test* |
| DatasourceId | long | No | The data source ID. | 327 |
| DirtyDataProcessPattern | string | No | The dirty data processing mode. | STOP |
| ExactlyOnce | string | No | Specifies whether to enable the consistency check. | false |
| UnixTimestampConvert | object | No | The timestamp conversion. | |
| Convert | string | No | Specifies whether to enable the conversion of timestamps. | false |
| Format | string | No | The format of the timestamp. | yyyyMMdd |
| Transform | boolean | No | Specifies whether to enable the timestamp conversion. | false |
| UserName | string | Yes | The name of the database account. | user_test |
| Password | string | Yes | The password of the database account. | test_user |
| DirtyDataHandleMode | string | Yes | The dirty data processing mode. | - |
Response parameters
Examples
Sample success responses
JSONformat
{
"HttpStatusCode": 200,
"Data": "-",
"RequestId": "******-3EEC-******-9F06-******",
"Success": true,
"Code": "InvalidInput",
"Message": "Success"
}Error codes
For a list of error codes, visit the Service error codes.