CreateApsHiveJob - AnalyticDB - Alibaba Cloud Documentation Center

Creates an AnalyticDB Pipeline Service (APS) job from a Hive data source.

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

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL cluster.	amv-****
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
WorkloadName	string	Yes	The name of the workload.	xxx-20240224100253
ResourceGroup	string	Yes	The name of the resource group.	user_default
FullComputeUnit	string	Yes	The number of AnalyticDB compute units (ACUs) required for data migration.	16
DatasourceId	long	No	The data source ID.	40
SyncAllowExpression	string	No	The expression that allows objects to be synchronized.	*
SyncDenyExpression	string	No	The expression that denies objects to be synchronized.	abc
TargetType	string	No	The destination type.	OSS
OssLocation	string	Yes	The path of the destination data lakehouse in an Object Storage Service (OSS) bucket.	oss://test-test/0516/
ConflictStrategy	string	No	The policy to handle tables with the same name in the destination cluster.	Intercept: reports error and aborts. Ignore: ignores and continues migrating the relevant tables. Skip: skips related tables and only migrates other tables.
AdvancedConfig	string	No	The advanced configurations.	-
Parallelism	integer	No	The number of tasks that are allowed in parallel.	8

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	2895BB82-B2C1-408E-AA73-DB8D59******
Data	string	The returned data.	-
HttpStatusCode	string	The response code. The status code 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The response 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.	Success

Examples

Sample success responses

JSONformat

{
  "RequestId": "2895BB82-B2C1-408E-AA73-DB8D59******",
  "Data": "-",
  "HttpStatusCode": 200,
  "Success": true,
  "Code": "InvalidInput",
  "Message": "Success"
}

Error codes

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