All Products
Search
Document Center

AnalyticDB:ModifyApsJob

Last Updated:Nov 10, 2025

Modifies an AnalyticDB Pipeline Service (APS) job.

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:ModifyApsJobupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ApsJobIdstringYes

The job ID.

aps-bj1xxxxxx
DbListstringYes

The objects to be synchronized.

{"EntireInstance":true}
PartitionListstringNo

The partitions.

{}

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

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

200
ApsJobIdstring

The job ID.

aps-bj1xxxxxx
RequestIdstring

The request ID.

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

Indicates whether the request was successful. Valid values:

  • true
  • false
True
ErrCodestring

The error code.

Success
ErrMessagestring

The error message returned if the request failed.

OK
Codestring

The status code. A value of 200 indicates that the request is successful.

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,
  "ApsJobId": "aps-bj1xxxxxx",
  "RequestId": "******-3EEC-******-9F06-******",
  "Success": true,
  "ErrCode": "Success",
  "ErrMessage": "OK",
  "Code": "InvalidInput\n",
  "Message": "SUCCESS"
}

Error codes

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