ConfigureResultExport - AnalyticDB - Alibaba Cloud Documentation Center

Configures the export destination (SLS or OSS) at the instance level. The configuration is unique per instance and follows the "configure once, use multiple times" principle.

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:ConfigureResultExport	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the instance resides.	cn-shenzhen
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.	amv-wz9509beptiz****
ExportType	string	No	The export type. Valid values: SLS: Specifies that the export destination is SLS. OSS: Specifies that the export destination is OSS.	SLS
SlsInfo	object	No	The SLS configuration details if the destination is of the SLS type.
SlsProject	string	No	The name of the SLS project.	test-project
ResourceGroup	string	No	The name of the resource group that runs the job.	aps
LogstoreTtl	integer	No	The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day, maximum: 30 days. Values outside this range will result in an error.	10
OssInfo	object	No	The OSS configuration details if the destination is of the OSS type.
ExportBasePath	string	No	The OSS path where the result sets are stored.	oss://testBucketName/data_result
ResourceGroup	string	No	The name of the resource group that runs the job.	aps
ResultFileTtl	integer	No	The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days. Values outside this range will result in an error.	10

Response parameters

Parameter	Type	Description	Example
	object	ResultData<?>
RequestId	string	The ID of the request.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Success	boolean	Indicates whether the request is successful. Valid values: true: Succeeded. false: Failed.	true
HttpStatusCode	integer	The HTTP status code. A value of 200 indicates that the request is successful.	200
Message	string	The returned message. Valid values: OK is returned if the request is normal. The specific error code is returned if the request is abnormal,	OK
Code	string	The backend error code.	200
Data	object	The path where the result sets are stored.
ExportType	string	The export type. Valid values: SLS: Indicates that the export destination is SLS. OSS: Indicates that the export destination is OSS.	SLS
SlsInfo	object	The SLS configuration if the destination is of the SLS type.
SlsProject	string	The name of the SLS project.	test-project
ResourceGroup	string	The name of the resource group that runs the job.	aps
LogstoreTtl	integer	The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day. Maximum value: 30 days.	10
OssInfo	object	The OSS configuration if the destination is of the OSS type.
ExportBasePath	string	The OSS path where the result sets are stored.	oss://testBucketName/data_result
ResourceGroup	string	The name of the resource group that runs the job.	aps
ResultFileTtl	integer	The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Success": true,
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Data": {
    "ExportType": "SLS",
    "SlsInfo": {
      "SlsProject": "test-project",
      "ResourceGroup": "aps",
      "LogstoreTtl": 10
    },
    "OssInfo": {
      "ExportBasePath": "oss://testBucketName/data_result",
      "ResourceGroup": "aps",
      "ResultFileTtl": 10
    }
  }
}

Error codes

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