All Products
Search
Document Center

AnalyticDB for MySQL:DescribeDownloadRecords

Last Updated:Mar 15, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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:DescribeDownloadRecordsRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the detailed information of all AnalyticDB for MySQL clusters within a specific region, including cluster IDs.
am-****************
RegionIdstringYes

The region ID of the cluster.

Note You can call the DescribeRegions operation to query the regions and zones supported by AnalyticDB for MySQL, including region IDs.
cn-hangzhou
LangstringNo

The languages available for file titles and some error messages. Default value: zh. Valid values:

  • zh: Simplified Chinese
  • en: English
  • ja: Japanese
  • zh-tw: Traditional Chinese
zh

Response parameters

ParameterTypeDescriptionExample
object
Recordsobject []

Details about the download tasks.

Statusstring

The status of the download task.

  • running: The download task is currently in progress.
  • finished: The download task is complete.
  • failed: The download task has failed.
finished
DownloadIdlong

The ID of the download task.

69
ExceptionMsgstring

The error message returned when the download task has failed.

The query result is empty.
Urlstring

The download URL of the file.

https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******"
FileNamestring

The name of the downloaded file.

20210806094635-20210806095135
RequestIdstring

The ID of the request.

987F51BE-C4CB-332A-B159-63CE87******

Examples

Sample success responses

JSONformat

{
  "Records": [
    {
      "Status": "finished",
      "DownloadId": 69,
      "ExceptionMsg": "The query result is empty.",
      "Url": "https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******\"",
      "FileName": "20210806094635-20210806095135"
    }
  ],
  "RequestId": "987F51BE-C4CB-332A-B159-63CE87******"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-01-04The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.