All Products
Search
Document Center

PolarDB:DescribeCharacterSetName

Last Updated:Mar 01, 2024

Queries character sets that are supported by a PolarDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the cluster.

Note You can call the DescribeRegions operation to query available regions.
cn-hangzhou
DBClusterIdstringNo

The ID of the cluster.

Note You can only query character sets that PolarDB for MySQL clusters support. If you enter the ID of a PolarDB for PostgreSQL or PolarDB for Oracle cluster, the returned value of the CharacterSetNameItems parameter is an empty string.
pc-****************

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

34458CD3-33E0-4624-BFEF-840C15******
CharacterSetNameItemsarray

The character sets that are supported.

string
{ "CharacterSetName": [ "utf8mb4", "utf8", "utf32", "utf16le", "utf16", "ujis", "ucs2", "tis620", "swe7", "sjis", "macroman", "macce", "latin7", "latin5", "latin2", "latin1", "koi8u", "koi8r", "keybcs2", "hp8", "hebrew", "greek", "geostd8", "gbk", "gb2312", "euckr", "eucjpms", "dec8", "cp932", "cp866", "cp852", "cp850", "cp1257", "cp1256", "cp1251", "cp1250", "binary", "big5", "ascii", "armscii8" ] }
Enginestring

The type of the database engine.

POLARDB

Examples

Sample success responses

JSONformat

{
  "RequestId": "34458CD3-33E0-4624-BFEF-840C15******",
  "CharacterSetNameItems": {
    "CharacterSetName": [
      "{ \"CharacterSetName\": [       \"utf8mb4\",       \"utf8\",       \"utf32\",       \"utf16le\",       \"utf16\",       \"ujis\",       \"ucs2\",       \"tis620\",       \"swe7\",       \"sjis\",       \"macroman\",       \"macce\",       \"latin7\",       \"latin5\",       \"latin2\",       \"latin1\",       \"koi8u\",       \"koi8r\",       \"keybcs2\",       \"hp8\",       \"hebrew\",       \"greek\",       \"geostd8\",       \"gbk\",       \"gb2312\",       \"euckr\",       \"eucjpms\",       \"dec8\",       \"cp932\",       \"cp866\",       \"cp852\",       \"cp850\",       \"cp1257\",       \"cp1256\",       \"cp1251\",       \"cp1250\",       \"binary\",       \"big5\",       \"ascii\",       \"armscii8\" ]  }"
    ]
  },
  "Engine": "POLARDB"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidRegionId.MalformedThe specified parameter RegionId is not valid.The specified RegionId parameter is invalid.
404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    Added Error Codes: 404