Updated on 2025-09-19 GMT+08:00

Exporting Database Users or Roles

Function

This API is used to export database users and roles. After you call this API, an output stream in XLSX format is returned.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/clusters/{cluster_id}/db-manager/users/export

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Page offset, which starts from 0 (page number minus 1).

Constraints

N/A

Range

Greater than or equal to 0

Default Value

0

limit

No

Integer

Definition

Size of a single page.

Constraints

N/A

Range

N/A

Default Value

10000

type

No

String

Definition

Type.

Constraints

N/A

Range

ROLE

USER

Default Value

null

Request Parameters

None

Response Parameters

Status code: 200

None

Example Requests

GET https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/a89aea88-7ea2-40bd-8ac8-8b93e169e5d6/db-manager/users/export

Example Responses

None

Status Codes

Status Code

Description

200

User or role list. After you call this API, an output stream in XLSX format is returned.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.