DescribeDownloadRecords API Reference for Diagnostic Records - AnalyticDB for PostgreSQL

Operation description

You must call the DownloadDiagnosisRecords API to download query diagnostic information before using this API to view the download records.

This feature is available only for storage-elastic mode instances with a minor engine version of V6.3.10.1 or later. To view and upgrade the minor engine version, see View the minor engine version and Upgrade the kernel version.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gpdb:DescribeDownloadRecords

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances API to view the details of all AnalyticDB for PostgreSQL instances in a specific Region, including the instance ID.	gp-bp12ga6v69h86****
DownloadTaskType	string	No

Response elements

Element	Type	Description	Example
	object	The response object.
Records	array<object>	A list of download records.
	object	A download record object.
DownloadId	integer	The download record ID.	1150
ExceptionMsg	string	The error message.	Error message
FileName	string	The file name.	20220509113448-20220509173448.csv
Status	string	When you request to download query diagnostic information, the file is first uploaded to Object Storage Service (OSS). You can download the file after the upload is complete. This parameter indicates the status of the upload. Valid values: running: The upload is in progress. finished: The upload is complete. failed: The upload has failed.	finished
DownloadUrl	string	The download URL.	https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****
RequestId	string	The request ID.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B

Examples

Success response

JSON format

{
  "Records": [
    {
      "DownloadId": 1150,
      "ExceptionMsg": "Error message",
      "FileName": "20220509113448-20220509173448.csv",
      "Status": "finished",
      "DownloadUrl": "https://perth-download-task.oss-cn-beijing.aliyuncs.com/*****"
    }
  ],
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.