All Products
Search
Document Center

AnalyticDB:ListApsOptimizationTasks

Last Updated:Nov 10, 2025

Queries a list of optimization jobs executed based on a lifecycle management policy. The system runs optimization jobs on a regular basis based on lifecycle management policies.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
DBClusterIdstringYes

The cluster ID.

amv-*******
StrategyTypestringYes

The type of the lifecycle management policy.

StrategyValue
StartTimestringNo

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2022-01-23T02:18Z
EndTimestringNo

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2022-09-30T00:15Z
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

30

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

******-3EEC-******-9F06-******
Itemsarray<object>

The queried optimization jobs.

-
Itemobject

The queried optimization job.

ComputeUnitstring

The computing resources used by the optimization job.

2
CreatedTimestring

The time when the optimization job was created.

2022-01-23T02:18Z
ModifiedTimestring

The time when the optimization job was modified.

2022-09-30T00:15Z
TaskDescstring

The description of the optimization job.

test
TaskDurationlong

The execution duration of the optimization job.

1000
TaskIdstring

The job ID.

sj-hz******
TaskMessagestring

The error message.

-
TaskStatusstring

The execution status. Valid values:

  1. NEW
  2. RUNNING
  3. SUCCESS
  4. STOPPED
  5. FAILED
RUNNING
StrategyTypestring

The type of the lifecycle management policy.

StrategyValue
DBClusterIdstring

The cluster ID.

amv-*******
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

30
TotalCountlong

The total number of entries returned.

15
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
HttpStatusCodeinteger

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

200
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

{
  "RequestId": "******-3EEC-******-9F06-******",
  "Items": [
    {
      "ComputeUnit": 2,
      "CreatedTime": "2022-01-23T02:18Z",
      "ModifiedTime": "2022-09-30T00:15Z",
      "TaskDesc": "test",
      "TaskDuration": 1000,
      "TaskId": "sj-hz******",
      "TaskMessage": "-",
      "TaskStatus": "RUNNING",
      "StrategyType": "StrategyValue",
      "DBClusterId": "amv-*******"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 15,
  "Success": true,
  "HttpStatusCode": 200,
  "Code": "InvalidInput",
  "Message": "SUCCESS"
}

Error codes

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