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

调试

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

请求参数


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

返回数据


名称	类型	示例值	描述
Message	String	Success	返回信息，成功返回success，错误返回对应错误码。
RequestId	String	C458B1E8-1683-3645-B154-6BA32080EEA	请求ID。
Success	Boolean	true	请求是否成功。
Data	Array of DB		数据库列表。
DBName	String	test	数据库名称。
DBDescription	String	test	数据库描述。
DBInstanceName	String	pxc-********	实例名称。
CharacterSetName	String	utf8mb4	字符集。
Accounts	Array of Account		账户列表。
AccountPrivilege	String	ReadWrite	权限。
AccountName	String	root4test	账户名称。

示例

请求示例

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

正常返回示例

XML格式

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

<DescribeDbListResponse>
    <Message>Success</Message>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <Success>true</Success>
    <Data>
        <DBName>test</DBName>
        <DBDescription>test</DBDescription>
        <DBInstanceName>pxc-********</DBInstanceName>
        <CharacterSetName>utf8mb4</CharacterSetName>
        <Accounts>
            <AccountPrivilege>ReadWrite</AccountPrivilege>
            <AccountName>root4test</AccountName>
        </Accounts>
    </Data>
</DescribeDbListResponse>

JSON格式

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

{
  "Message" : "Success",
  "RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Success" : true,
  "Data" : [ {
    "DBName" : "test",
    "DBDescription" : "test",
    "DBInstanceName" : "pxc-********",
    "CharacterSetName" : "utf8mb4",
    "Accounts" : [ {
      "AccountPrivilege" : "ReadWrite",
      "AccountName" : "root4test"
    } ]
  } ]
}

错误码

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