PolarDB-X 1.0-API参考-1.0（2019版本）-数据表管理-DescribeTableListByType

更新时间：2022-05-06 03:48:47

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTableListByType	系统规定参数。取值：DescribeTableListByType。
DbName	String	是	drds_flashback	数据库名
DrdsInstanceId	String	是	drdshbga76p61861	DRDS实例Id
Query	String	是	drdshbga76p61861	搜索字段
TableType	String	是	SINGLE	表类型
CurrentPage	Integer	否	1	当前页
PageSize	Integer	否	10	每页大小
RegionId	String	否	cn-hangzhou	RegionId

返回数据

名称	类型	示例值	描述
List			返回集合
PageNumber	Integer	1	第几页
PageSize	Integer	10	每页大小
RequestId	String	B360F47B-59E3-4D1C-BA03-6BFB1C993F88	请求唯一ID，如果遇到问题请提供这个请求ID，由工作人员为您排查。
Success	Boolean	true	当前API是否请求成功
Total	Integer	1	总数量

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeTableListByType
&<公共请求参数>

正常返回示例

XML 格式

<DescribeTableListByTypeResponse>
      <code>200</code>
      <data>
            <PageSize>10</PageSize>
            <RequestId>B360F47B-59E3-4D1C-BA03-6BFB1C993F88</RequestId>
            <PageNumber>1</PageNumber>
            <Total>1</Total>
            <List>
                  <TableName>employee_split</TableName>
                  <Property>single</Property>
            </List>
            <Success>true</Success>
      </data>
      <requestId>B360F47B-59E3-4D1C-BA03-6BFB1C993F88</requestId>
      <successResponse>true</successResponse>
    
</DescribeTableListByTypeResponse>

JSON 格式

{
    "successResponse":true,
    "requestId":"B360F47B-59E3-4D1C-BA03-6BFB1C993F88",
    "data":{
        "PageNumber":1,
        "PageSize":10,
        "RequestId":"B360F47B-59E3-4D1C-BA03-6BFB1C993F88",
        "Success":true,
        "List":[
            {
                "TableName":"employee_split",
                "Property":"single"
            }
        ],
        "Total":1
    },
    "code":"200"
}

PolarDB-X 1.0-API参考-1.0（2019版本）-数据表管理-DescribeTableListByType

请求参数

返回数据

示例

错误码

相关阅读

推荐文章