Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Log Management/ Obtaining Links for Downloading Audit Logs
Updated on 2025-10-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Links for Downloading Audit Logs

Function

This API is used to obtain links for downloading audit logs. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:auditlog:list

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:list

    -

URI

POST /v3/{project_id}/instances/{instance_id}/audit-log-link

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

Definition

List of audit log IDs. To obtain this value, see Obtaining Audit Logs.

Constraints

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

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

links

Array of strings

Definition

List of audit log download links. The links are valid for 5 minutes.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Obtaining links for downloading audit logs

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/audit-log-link

{
  "ids" : [ "fa163e9970a3t11e9d834e122fdceb1d6br01", "fa163ea0e2bet11e9d8364943103c94c5br01" ]
}

Example Response

Status code: 200

Success.

{
  "links" : [ "https://obs.domainname.com/rdsbucket.username.1/xxxxxx", "https://obs.domainname.com/rdsbucket.username.2/xxxxxx" ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Log Management