Queries the character sets that are supported by databases in a PolarDB-X instance.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCharacterSet

The operation that you want to perform. Set the value to DescribeCharacterSet.

DBInstanceName String Yes pxc-*********

The name of the PolarDB-X instance.

RegionId String Yes cn-hangzhou

The ID of the region where the PolarDB-X instance is deployed.

Response parameters

Parameter Type Example Description
Message String success

The message that is returned. If the request is successful, "success" is returned. If the request fails, an error code is returned.

RequestId String 709C1E40-092D-4A3D-9958-6D7438******

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Data Object

The data that is returned.

Engine String polarx

The storage class of databases in the PolarDB-X instance. Set the value to polarx.

CharacterSet Array of String utf8

The character sets that are supported by databases in the PolarDB-X instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCharacterSet
&DBInstanceName=pxc-*********
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCharacterSetResponse>
    <Message>success</Message>
    <RequestId>709C1E40-092D-4A3D-9958-6D7438******</RequestId>
    <Success>true</Success>
    <Data>
        <Engine>polarx</Engine>
        <CharacterSet>utf8</CharacterSet>
    </Data>
</DescribeCharacterSetResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "success",
  "RequestId" : "709C1E40-092D-4A3D-9958-6D7438******",
  "Success" : true,
  "Data" : {
    "Engine" : "polarx",
    "CharacterSet" : [ "utf8" ]
  }
}

Error codes

For a list of error codes, visit the API Error Center.