All Products
Search
Document Center

ApsaraDB for OceanBase (Deprecated):DescribeCharset

Last Updated:Jun 26, 2026

Queries the character set information of an OceanBase tenant.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

TenantMode

string

Yes

The tenant mode. Valid values: Oracle and MySQL.
For more information, see DescribeInstanceTenantModes.

Oracle

Series

string

No

The edition of the instance. Valid values: - normal (default): Cluster Edition (cloud disk) - normal_ssd: Cluster Edition (local disk) - history: Archive Database Cluster Edition.

normal

InstanceId

string

No

The ID of the OceanBase cluster.

ob317v4uif****

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

Charset

array<object>

The list of character sets.

object

The response parameters.

Charset

string

The character set name.

utf8

Collations

array

The collection of collations.

string

The collection of collations.

["utf8mb4_general_ci","utf8mb4_bin","binary"]

Examples

Success response

JSON format

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Charset": [
    {
      "Charset": "utf8",
      "Collations": [
        "[\"utf8mb4_general_ci\",\"utf8mb4_bin\",\"binary\"]"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.