Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Management/ Querying Available Database Character Sets
Updated on 2025-07-11 GMT+08:00

Querying Available Database Character Sets

Function

This API is used to query available database character sets of a TaurusDB instance. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/databases/charsets

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 can contain 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

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

  • en-us

  • zh-cn

Default value:

en-us

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

charsets

Array of strings

Definition:

List of database character sets.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying available database character sets

Example Response

Status code: 200

Success.

{
  "charsets" : [ "utf8mb4", "gbk" ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.