Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Log Information Queries/ Obtaining Links for Downloading Error Logs (RDS for PostgreSQL)
Updated on 2025-08-20 GMT+08:00

Obtaining Links for Downloading Error Logs (RDS for PostgreSQL)

Function

This API is used to obtain links for downloading error logs of a DB instance.

You need to call this API repeatedly until FINISH is returned for status.

Or, you can use the workflow_id value returned by the first API call to query the task status. After the task is successfully executed, call the API again to obtain the download link.

Constraints

This API can only be used to obtain links for downloading error logs of an instance that is working properly.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/errorlog-download

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    ID of the instance to be queried.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

  • Parameter description

    None

  • URI example

    POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3d39c18788b54a919bab633874c159dfin01/errorlog-download

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    list

    Array of objects

    Definition

    List of links for downloading error logs. For details, see Table 3.

    status

    String

    Definition

    Status of the error log download link.

    Range

    • FINISH: The download link has been generated.
    • CREATING: A file is being generated and the download link is being prepared.
    • FAILED: The log file fails to be prepared.

    count

    Integer

    Definition

    Number of error log links.

    Range

    N/A

    Table 3 Data structure description of the list field

    Parameter

    Type

    Description

    workflow_id

    String

    Definition

    Task ID.

    Range

    N/A

    file_name

    String

    Definition

    Name of the generated file for downloading.

    Range

    N/A

    status

    String

    Definition

    Status of the current link.

    Range

    N/A

    file_size

    String

    Definition

    File size.

    Range

    N/A

    file_link

    String

    Definition

    Download link.

    Range

    N/A

    create_at

    Long

    Definition

    Generation time.

    Range

    N/A

    update_at

    Long

    Definition

    Update time.

    Range

    N/A

  • Example normal response

    Link for downloading error logs obtained successfully.

    { 
       "list" : [ { 
         "workflow_id" : "44fb1d85-2fcc-4d63-ad3b-c3d1ecd7000e", 
         "file_name" : "054bc9c1f680d55c1f36c006e5a9f67b_errorlog_download_20200515080614589", 
         "file_size" : "0", 
         "file_link" : "https://rdsbucket.xxx.myhuaweicloud.com:443/054bc9c1f680d55c1f36c006e5a9f67b_errorlog_download_20200515080614589?AWSAccessKeyId=1BQ38TBCQHAVQXBUMUTC&Expires=1589530200&response-cache-control=no-cache%2Cno-store&Signature=Fgi4%2BLOJ9frAXyOkz5hRoW5O%2BUM%3D", 
         "create_at" : 1589529991385, 
         "update_at" : 1589529991385 
       } ], 
       "status" : "finish", 
       "count" : 1 
     }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.