All Products
Search
Document Center

AnalyticDB:DescribeApsJobDetail

Last Updated:Nov 10, 2025

Queries the information about an AnalyticDB Pipeline Service (APS) job.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-beijing
ApsJobIdstringYes

The job ID.

aps-******

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

******-E606-4A42-BF6D-******
APSJobDetailobject

The queried job.

SourceEndpointRegionstring

The region of the source instance.

cn-beijing
SourceEndpointInstanceIDstring

The ID of the source instance.

pc-*******
DestinationEndpointRegionstring

The region of the destination cluster.

cn-beijing
DestinationEndpointInstanceIDstring

The ID of the destination cluster.

amv-******
PartitionListstring

The partitions.

{}
DbListstring

The objects that are synchronized.

{}
TargetTableModestring

The mode of the destination table.

0
Statusstring

The status of the job.

Running

Examples

Sample success responses

JSONformat

{
  "RequestId": "******-E606-4A42-BF6D-******",
  "APSJobDetail": {
    "SourceEndpointRegion": "cn-beijing",
    "SourceEndpointInstanceID": "pc-*******",
    "DestinationEndpointRegion": "cn-beijing",
    "DestinationEndpointInstanceID": "amv-******",
    "PartitionList": {},
    "DbList": {},
    "TargetTableMode": 0,
    "Status": "Running"
  }
}

Error codes

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

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