All Products
Search

This Product

    AnalyticDB:ListResultExportJobHistory

    Document Center

    AnalyticDB:ListResultExportJobHistory

    Last Updated:Nov 10, 2025

    Queries the execution records of result set export jobs of a Resource Access Management (RAM) user.

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    adb:ListResultExportJobHistorylist
    *DBClusterLakeVersion
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the cluster.

    Note You can call the DescribeRegions operation to query the most recent region list.
    		cn-hangzhou
    DBClusterIdstringYes

    The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.

    Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.
    		amv-7xv5ty5m9o4v****
    PageNumberstringNo

    The page number. Pages start from page 1.

    		1
    PageSizestringNo

    The number of entries per page. Valid values:

    • 30 (default)
    • 50
    • 100
    		30
    StartTimestringNo

    The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    		2022-01-01T12:01:00Z
    EndTimestringNo

    The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    Note The end time must be later than the start time.
    		2023-05-25T06:54:00Z
    OrderobjectNo

    The order in which to sort the SQL statements by field, which contains the Field and Type fields. Specify the order in the JSON format. Example: [{"Field":"CreateTimee", "Type": "desc" }].

    • Field specifies the field that is used to sort the SQL statements. Valid values:

      • CreateTime: the time when the result set export job was created.
      • Status: the execution status.
      • DatabaseUser: the name of the database account.
      • TimeCost: the execution duration.
      • ResourceGroup: the name of the resource group.
      • ExportRows: the number of exported rows.
      • Progress: the export progress.

    • Type specifies the sorting order. Valid values (case-insensitive):

      • Desc: descending order.
      • Asc: ascending order.
    FieldstringNo

    The field that is used to sort the SQL statements. Valid values:

    • CreateTime
    • DatabaseUser
    • TimeCost
    • ResourceGroup
    • Status
    • Progress
    • ExportRows
    		DatabaseUser
    TypestringNo

    The sorting order. Valid values (case-insensitive):

    • Desc: descending order.
    • Asc: ascending order.
    		Desc
    StatusListarrayNo

    The execution status of result set export jobs. You can use this parameter to query the execution records of export jobs that are in a specific state.

    stringNo

    Valid values:

    1. SUBMITTED
    2. RUNNING
    3. SUCCEEDED
    4. FAILED
    		RUNNING
    ResourceGroupstringNo

    The name of the resource group that runs the result set export jobs. You can use this parameter to query the execution records of export jobs that are run in a specific resource group.

    		user_default
    DatabaseUserstringNo

    The name of the database account.

    		test1

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		1AD222E9-E606-4A42-BF6D-8A4442913CEF
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    HttpStatusCodeinteger

    The response code. The status code 200 indicates that the request was successful.

    		200
    Messagestring

    The returned message. Valid values:

    • If the request was successful, an OK message is returned.
    • If the request failed, an error message is returned.
    		OK
    Codestring

    The HTTP status code.

    		InvalidInput
    Itemsarray<object>

    The queried result set export jobs.

    itemobject

    The queried result set export job.

    DBClusterIdstring

    The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

    		amv-7xv5ty5m9o4v****
    AliUidstring

    The RAM user ID.

    		120010511678****
    Sqlstring

    The SQL statement that is used in the result set export job.

    		SELECT * FROM `ADB_SampleData_TPCH`.`supplier` LIMIT 20
    CreateTimestring

    The time when the result set export job was created. The time follows the ISO 8601 standard in the yyyy-mm-ddThh:mm:ssZ format. The time is displayed in UTC.

    		2022-04-01T09:50:18Z
    StartTimestring

    The start time of the result set export job. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		2021-07-03T04:00:00Z
    EndTimestring

    The end time of the result set export job. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    Note The end time must be later than the start time.
    		2023-06-15T02:13:00Z
    DatabaseUserstring

    The name of the database account that is associated with the RAM user.

    		ram_user
    TimeCostlong

    The amount of time consumed to export execution records. Unit: milliseconds.

    Note The value is the duration between the time when the result set export job starts and the time when the result set export job ends.
    		560
    ExportJobIdstring

    The unique identifier of the result set export job.

    		export_2024051319271219802100800401300****
    ResourceGroupstring

    The name of the resource group that runs the result set export job.

    		test
    Statusstring

    The execution status of the result set export job. Valid values:

    1. SUBMITTED
    2. RUNNING
    3. SUCCEEDED
    4. FAILED
    		RUNNING
    ExportPathstring

    The complete URL of the path to store the exported result set.

    		oss://testBucketName/export_test/result_export/2024/05/13/202405131528400210090110690315154****/result.csv
    Progressstring

    The progress of the result set export job. Unit: %. Valid values: 0 to 100.

    		30
    ProcessIdstring

    The query ID that can be used for diagnostics.

    Note You can call the DescribeDiagnosisSQLInfo operation to query the execution information about a query.
    		202306121421111720161451770345339****
    ExportRowsstring

    The number of exported rows. This parameter is returned only when the request was successful.

    		10000
    Messagestring

    The returned message. This parameter is returned only when the request failed.

    		Failed to execute SQL
    Enginestring

    The engine that is used to execute the result set export job. Only XIHE is returned.

    		XIHE
    Schemastring

    The name of the database.

    		lake_db
    ExportTypestring

    The type of the result set export job.

    		-
    IsExpiredboolean

    Indicates whether the result set export job has expired. Valid values:

    • false
    • true
    PageNumberinteger

    The page number.

    		1
    PageSizeinteger

    The number of entries per page.

    		10
    TotalCountlong

    The total number of entries returned.

    		174

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Success": true,
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": "InvalidInput",
  "Items": [
    {
      "DBClusterId": "amv-7xv5ty5m9o4v****",
      "AliUid": "120010511678****",
      "Sql": "SELECT * FROM `ADB_SampleData_TPCH`.`supplier` LIMIT 20",
      "CreateTime": "2022-04-01T09:50:18Z",
      "StartTime": "2021-07-03T04:00:00Z",
      "EndTime": "2023-06-15T02:13:00Z",
      "DatabaseUser": "ram_user",
      "TimeCost": 560,
      "ExportJobId": "export_2024051319271219802100800401300****\n",
      "ResourceGroup": "test",
      "Status": "RUNNING",
      "ExportPath": "oss://testBucketName/export_test/result_export/2024/05/13/202405131528400210090110690315154****/result.csv",
      "Progress": 30,
      "ProcessId": "202306121421111720161451770345339****",
      "ExportRows": 10000,
      "Message": "Failed to execute SQL",
      "Engine": "XIHE",
      "Schema": "lake_db",
      "ExportType": "-",
      "IsExpired": true
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 174
}

    Error codes

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