DescribeCharacterSet - 云原生数据库 PolarDB

调用DescribeCharacterSet接口查询目标实例下数据库所支持的字符集类型。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCharacterSet	系统规定参数。取值：DescribeCharacterSet。
DBInstanceName	String	是	pxc-*********	实例ID。
RegionId	String	是	cn-hangzhou	实例所属地域的ID。

返回数据


名称	类型	示例值	描述
Message	String	success	返回信息，正确返回success，错误返回错误码。
RequestId	String	709C1E40-092D-4A3D-9958-6D7438******	请求ID。
Success	Boolean	true	请求是否成功。
Data	Object		数据结构体。
Engine	String	polarx	目标实例下数据库的存储类型，目前仅支持polarx。
CharacterSet	Array of String	utf8	字符集。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCharacterSet
&DBInstanceName=pxc-*********
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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格式

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

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

错误码

访问错误中心查看更多错误码。