Updated on 2025-08-22 GMT+08:00

Obtaining Links for Downloading Audit Logs

Description

This API is used to obtain the link for downloading audit logs.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-links

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/2870a411522849aa901cd4351c96a3b7in02/auditlog-links

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

Explanation:

User token obtained from IAM. For details, see Authentication.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

string

path

Yes

Explanation:

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

string

path

Yes

Explanation:

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    ids

    Array of strings

    Yes

    The list of audit logs. A maximum of 50 audit log IDs are allowed in the list.

Example Request

Obtaining the link for downloading audit logs based on the audit log ID list
{
   "ids": ["10190012aae94b38a10269b8ad025fc1no02_1607681849871", "12390012aae94b38a10269b8ad025fc1no02_1607681849871"]
}

Response Parameters

  • Parameter description
    Table 3 Parameter description

    Name

    Type

    Description

    links

    Array of strings

    Indicates the list of audit log download links. The validity period is 5 minutes.

  • Response example
    {
        "links": ["https://obs.domainname.com/ddsbucket.username.1/xxxxxx", "https://obs.domainname.com/ddsbucket.username.2/xxxxxx"]
     }

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.