PolarDB-X 云原生分布式数据库 DescribeCharacterSet

By | 2021年4月22日

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCharacterSet

系统规定参数。取值为DescribeCharacterSet

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

实例ID。

RegionId String cn-hangzhou

实例所在地域。

返回数据

名称 类型 示例值 描述
Data Struct

字符编码集信息。

CharacterSet List ["utf8mb4", "gbk", "latin1", "utf8"]

实例支持的字符编码集,取值范围如下:

  • utf8mb4
  • gbk
  • latin1
  • utf8
Engine String polarx

目标实例下数据库的存储类型,目前存储类型取值仅支持polarx

Message String *****

请求返回消息。

说明 请求成功时该参数为空,请求失败时会返回请求异常信息(如错误码等)。

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

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeCharacterSet
&DBInstanceName=pxc-****************
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<code>200</code>
<data>
    <RequestId>709C1E40-092D-4A3D-9958-6D7438******</RequestId>
    <Message/>
    <Data>
        <CharacterSet>utf8mb4</CharacterSet>
        <CharacterSet>gbk</CharacterSet>
        <CharacterSet>latin1</CharacterSet>
        <CharacterSet>utf8</CharacterSet>
        <Engine>polarx</Engine>
    </Data>
    <Success>true</Success>
</data>
<requestId>709C1E40-092D-4A3D-9958-6D7438******</requestId>
<successResponse>true</successResponse>

JSON 格式

{
  "code":"200",
  "data":{
        "RequestId": "709C1E40-092D-4A3D-9958-6D7438******",
        "Message": "",
        "Data": {
            "CharacterSet": [
                "utf8mb4",
                "gbk",
                "latin1",
                "utf8"
            ],
            "Engine": "polarx"
        },
        "Success": true
 },
  "requestId":"709C1E40-092D-4A3D-9958-6D7438******",
  "successResponse":true
}

错误码

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

请关注公众号获取更多资料

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注

Iconic One Theme | Powered by Wordpress