All Products
Search
Document Center

AnalyticDB:DescribeApsMigrationWorkloads

Last Updated:Nov 10, 2025

Queries the workloads of AnalyticDB Pipeline Service (APS) migration jobs.

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

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerYes

The page number.

1
PageSizeintegerYes

The number of entries per page.

30
DBClusterIdstringNo

The cluster ID.

amv-*******
WorkloadNamestringNo

The name of the workload.

test
OssLocationstringNo

The Object Storage Service (OSS) URL.

oss://******
StartTimestringNo

The start of the time range to query.

2021-06-20T16:00:00Z
EndTimestringNo

The end of the time range to query.

2021-07-20T16:00:00Z

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

******-3EEC-57F0-9F06-******
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

30
TotalCountinteger

The total number of entries returned.

0
MigrationWorkloadsarray<object>

The queried migration workloads.

Workloadsobject

The queried migration workloads.

ModifyTimestring

The time when the migration job was modified.

2021-06-21T02:15:16Z
CreateTimestring

The time when the job was created.

2021-06-21T02:15:16Z
Idstring

The job ID.

123
Statestring

The status.

COMPLETED
OssLocationstring

The OSS URL.

oss://******
TargetTypestring

The destination type.

OSS
WorkloadSubTypestring

The sub-type of the workload.

test
Namestring

The name of the workload.

TEST-001
AcuCountinteger

The number of AnalyticDB compute units (ACUs).

-
MaxRTstring

The maximum response time.

1000
FailedMsgstring

The error message.

-

Examples

Sample success responses

JSONformat

{
  "RequestId": "******-3EEC-57F0-9F06-******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 0,
  "MigrationWorkloads": [
    {
      "ModifyTime": "2021-06-21T02:15:16Z",
      "CreateTime": "2021-06-21T02:15:16Z",
      "Id": 123,
      "State": "COMPLETED",
      "OssLocation": "oss://******",
      "TargetType": "OSS",
      "WorkloadSubType": "test",
      "Name": "TEST-001",
      "AcuCount": 0,
      "MaxRT": 1000,
      "FailedMsg": "-"
    }
  ]
}

Error codes

HTTP status codeError codeError message
400InvalidInputThe specified parameter is invalid.

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