DescribeApsJobs - AnalyticDB - Alibaba Cloud Documentation Center

Queries a list of AnalyticDB Pipeline Service (APS) 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeApsJobs	list	*DBClusterLakeVersion `acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page.	30
RegionId	string	No	The region ID.	cn-beijing
CreateTimeStart	string	No	The beginning of the time range to query.	2022-03-23T01:10Z
CreateTimeEnd	string	No	The end of the time range to query.	2022-04-23T01:10Z
ApsJobName	string	No	The name of the APS job.	aps-xxxxx

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****-7F9D-5DBD-993E-****
PageNumber	string	The page number.	1
PageSize	string	The number of entries per page.	30
TotalCount	string	The total number of entries returned.	0
APSJobs	array<object>	The queried APS jobs.	-
oneStationVOs	object	The queried APS job.
Status	string	The status of the APS job.	-
ApsJobName	string	The name of the APS job.	data-sync-******
DestinationInstanceID	string	The destination cluster ID.	amv-*******
SourceInstanceID	string	The ID of the source instance or cluster.	pc-******
Delay	long	The synchronization latency.	0
CreateTime	string	The time when the APS job was created.	2022-06-28 15:00:04
Projress	string	The progress.	30: The progress is 30%.
ApsJobId	string	The job ID.	aps-******
SubStatus	string	The status of the task.	-
ErrMessage	string	The error message.	OK
Success	boolean	Indicates whether the request was successful. Valid values: true false	True
Code	string	The HTTP status code.	ok
Message	string	The returned message. Valid values: If the request was successful, a success message is returned.**** If the request failed, an error message is returned.	OK
HttpStatusCode	integer	The status code. A value of 200 indicates that the request was successful.	ok

Examples

Sample success responses

JSONformat

{
  "RequestId": "******-7F9D-5DBD-993E-******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 0,
  "APSJobs": [
    {
      "Status": "-",
      "ApsJobName": "data-sync-******",
      "DestinationInstanceID": "amv-*******",
      "SourceInstanceID": "pc-******",
      "Delay": 0,
      "CreateTime": "2022-06-28 15:00:04",
      "Projress": "30: The progress is 30%.",
      "ApsJobId": "aps-******",
      "SubStatus": "-",
      "ErrMessage": "OK"
    }
  ],
  "Success": true,
  "Code": "ok",
  "Message": "OK",
  "HttpStatusCode": 0
}

Error codes

HTTP status code	Error code	Error message
400	InvalidInput	The specified parameter is invalid.

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