StartApsJob - AnalyticDB - Alibaba Cloud Documentation Center

Starts 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.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID	cn-hangzhou
ApsJobId	string	Yes	The job ID.	aps-******

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The response code. The status code 200 indicates that the request was successful.	200
ApsJobId	string	The job ID.	aps-******
RequestId	string	The request ID.	****-3EEC-**-9F06-****
Success	boolean	Indicates whether the request was successful. Valid values: true false	True
ErrCode	string	The error code returned when the request fails.	0
ErrMessage	string	The error message returned if the request failed.	OK
Code	string	The HTTP status code or the error code.	200
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

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ApsJobId": "aps-******",
  "RequestId": "******-3EEC-******-9F06-******",
  "Success": true,
  "ErrCode": 0,
  "ErrMessage": "OK",
  "Code": 200,
  "Message": "OK"
}

Error codes

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