All Products
Search
Document Center

AnalyticDB:ModifyApsSlsADBJob

Last Updated:Nov 10, 2025

Modifies an AnalyticDB Pipeline Service (APS) job from Simple Log Service (SLS) to an AnalyticDB for MySQL Data Warehouse Edition cluster.

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

Request parameters

ParameterTypeRequiredDescriptionExample
WorkloadIdstringYes

The job ID.

aps-******
DBClusterIdstringYes

The cluster ID.

amv-*******
StartingOffsetsstringYes

The start offset.

end_cursor
Columnsarray<object>No

The information about columns.

-
objectNo

The information about columns.

NamestringNo

The name of the column.

test_name
MapNamestringNo

The name of the mapping.

map_name
TypestringNo

The data type of the column.

bigint
MapTypestringNo

The type of the mapping.

bigint
RegionIdstringYes

The region ID.

cn-hangzhou
WorkloadNamestringNo

The name of the workload.

test-name
DbNamestringNo

The name of the database.

dbName
TableNamestringNo

The name of the table.

test
DirtyDataProcessPatternstringNo

The dirty data processing mode.

STOP
ExactlyOncestringNo

Specifies whether to enable the consistency check.

true
UnixTimestampConvertstringNo

The timestamp conversion.

-
UserNamestringNo

The name of the database account.

user-name
PasswordstringNo

The password of the database account.

test_123

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

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

200
Dataobject

The returned data.

-
RequestIdstring

The request ID.

******-3EEC-******-9F06-******
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The HTTP status code or the error code.

InvalidInput
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.
SUCCESS

Examples

Sample success responses

JSONformat

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

Error codes

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