DocsICP FilingConsole
Documentation

CreateApsSlsADBJob

Updated at:
Copy as MD
My Favorites

Creates an APS link from Simple Log Service (SLS) to an AnalyticDB data warehouse.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:CreateApsSlsADBJob

none

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

 None 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 partition information.

-

object

No

The partition information.

-
Columns

array<object>

Yes

The column information.

-

object

No

The column information.

-
Name

string

No

The column name.

id
MapName

string

No

The mapping name.

test
Type

string

No

The column data type.

bigint
MapType

string

No

The mapping type.

int
PrimaryKeyDefinition

string

No

The primary key definition.

-
WorkloadName

string

Yes

The workload name.

sls-******
LakehouseId

integer

No

lakehosue ID.

123
ResourceGroup

string

No

The resource group name.

test
AdvancedConfig

string

No

The advanced configuration.

-
HudiAdvancedConfig

string

No

The Hudi advanced configuration.

-
FullComputeUnit

string

No

The number of AnalyticDB compute units (ACUs) for full data synchronization.

16
IncrementalComputeUnit

string

No

The number of AnalyticDB compute units (ACUs) for incremental data synchronization.

168
Project

string

No

The project name.

test
Store

string

No

sls Store.

test
StartingOffsets

string

Yes

The starting offset for delivery.

test
MaxOffsetsPerTrigger

integer

No

The maximum offset.

-
DbName

string

Yes

The database name.

dbName
TableName

string

Yes

The table name.

test
OutputFormat

string

No

The output format.

-
TargetType

string

No

The destination type.

ADB
TargetGenerateRule

string

No

The generation rule for the destination.

-
AcrossUid

string

No

The UID for cross-account access.

123456
AcrossRole

string

No

The role name for cross-account access.

test-role
SourceRegionId

string

No

The region ID of the source cluster.

cn-beijing
OssLocation

string

No

The OSS address.

oss://test*
DatasourceId

integer

No

The data source ID.

327
DirtyDataProcessPattern

string

No

The dirty data processing mode.

STOP
ExactlyOnce

string

No

Specifies whether to enable exactly-once semantics.

false
UnixTimestampConvert

object

No

The UNIX timestamp conversion configuration.

-
Convert

string

No

The conversion method.

false.
Format

string

No

The format.

APSyyyyMMdd
Transform

boolean

No

Specifies whether to enable conversion.

false
UserName

string

Yes

The username.

user_test
Password

string

Yes

The password.

test_user
DirtyDataHandleMode

string

Yes

The dirty data processing mode.

-

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code returned. A value of 200 indicates that the request was successful.

200
Data

string

The returned data.

-
RequestId

string

The request ID.

******-3EEC-******-9F06-******
Success

boolean

The result of the precheck. Valid values:

  • success: The check passed.

  • false: The check failed.

True
Code

string

The API status or POP error code.

InvalidInput
Message

string

The message returned for the call. Valid values:

  • If the request was successful, Success is returned.

  • If the request failed, the specific error message is returned.

Success

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Data": "-",
  "RequestId": "******-3EEC-******-9F06-******",
  "Success": true,
  "Code": "InvalidInput",
  "Message": "Success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.