CreateAPSJob - AnalyticDB - Alibaba Cloud Documentation Center

Creates an AnalyticDB Pipeline Service (APS) job.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
SourceEndpointInstanceID	string	Yes	The ID of the source instance or cluster.	pc-xxxxx
SourceEndpointRegion	string	No	The region ID of the source instance.	cn-beijing
SourceEndpointUserName	string	No	The name of the database account of the source instance.	xxxx
SourceEndpointPassword	string	No	The password of the database account of the source instance.	******
DestinationEndpointInstanceID	string	Yes	The name of the database account of the destination cluster.	amv-xxxxx
DestinationEndpointPassword	string	No	The password of the database account of the destination cluster.	******
DestinationEndpointUserName	string	No	The name of the database account of the destination cluster.	******
DbList	string	Yes	The objects to be synchronized.	{"EntireInstance":true}
ApsJobName	string	Yes	The name of the synchronization job.	aps-xxxxx
PartitionList	string	No	The partitions.	{}
TargetTableMode	string	No	The mode of the destination table.	1

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-bj1xxxxxx
RequestId	string	The request ID.	D1B8ED33-5E9B-512D-B188-1579ED6xxx
Success	boolean	Indicates whether the request was successful. Valid values: true false	True
Code	string	The HTTP status code or the error code.	InvalidInput
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-bj1xxxxxx",
  "RequestId": "D1B8ED33-5E9B-512D-B188-1579ED6xxx",
  "Success": true,
  "Code": "InvalidInput",
  "Message": "OK"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history