DescribeResultExportConfig - AnalyticDB - Alibaba Cloud Documentation Center

Queries the user-configured result set export settings.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	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-8vbf80pjcz*****
ExportType	string	No	The export type. Valid values: SLS: Indicates that the export destination is SLS. OSS: Indicates that the export destination is OSS.	SLS

Response parameters

Parameter	Type	Description	Example
	object	ResultData<?>
RequestId	string	Request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Success	boolean	Indicates whether the call was successful. Valid values: Valid values: True: Succeeded. **False: Failed.	true
HttpStatusCode	integer	The HTTP response status code. A value of 200 indicates that the request was successful.	200
Message	string	The returned message. Valid values: The request succeeded, and the server returns OK. The request failed, and the server returns an error message.	OK
Code	string	API status or POP error code.	InvalidInput
Data	object	The data returned.
ExportType	string	The export type. Valid values: SLS: Indicates that the export destination is SLS. OSS: Indicates that the export destination is OSS.	OSS
SlsInfo	object	The configured SLS export settings, returned when the export destination is SLS.
SlsProject	string	The name of the SLS project.	test-project
ResourceGroup	string	The name of the resource group that runs the export SQL.	aps
LogstoreTtl	integer	The expiration period (in days) for the temporary Logstore automatically created during result set export. The Logstore is automatically deleted after expiration. The returned value is between 1 and 30 days (inclusive).	10
OssInfo	object	The configured OSS export settings, returned when the export destination is OSS.
ExportBasePath	string	The path of the OSS bucket to which the result sets are exported.	oss://testBucketName/data_result
ResourceGroup	string	The name of the resource group that runs the export SQL.	aps
ResultFileTtl	integer	The expiration period (in days) for the OSS file. The returned value is between 1 and 30 days (inclusive).	10

Examples

Sample success responses

JSONformat

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

Error codes

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