调用DescribeTable接口查询table结构信息。

调试

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

调试

请求参数

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

系统固定参数，取值为DescribeTable。

DbName String 是 drds_flashback

数据库名。
DrdsInstanceId String 是 drds*********

实例ID。
TableName String 是 employee_split

表名。
RegionId String 否 cn-hangzhou

地域ID。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
Data Struct

返回数据。
List Array of ColumnInfo

返回数据集合。
ColumnName String Id

列名。
ColumnType String bigint(20)

列类型。
Extra String auto_increment

Extra
Index String PRI

主键。
IsAllowNull String NO

是否允许为空。
IsPk String YES

是否为主键。
RequestId String B5644ABB-559A-4A1C-83F2-9E7209******

请求唯一ID，如果遇到问题请提供这个请求ID，由工作人员为您排查。
Success Boolean true

当前API是否请求成功。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeTable
&DbName=drds_flashback
&DrdsInstanceId=drds*********
&TableName=employee_split
&<公共请求参数>

正常返回示例

XML格式 

<RequestId>B5644ABB-559A-4A1C-83F2-9E7209******</RequestId>
<Data>
    <List>
        <ColumnName>Id</ColumnName>
        <ColumnType>bigint(20)</ColumnType>
        <Extra>auto_increment</Extra>
        <IsAllowNull>NO</IsAllowNull>
        <IsPk>YES</IsPk>
        <Index>PRI</Index>
    </List>
</Data>
<Success>true</Success>

JSON格式 

{"RequestId":"B5644ABB-559A-4A1C-83F2-9E7209******","Data":{"List":[{"ColumnName":"Id","ColumnType":"bigint(20)","Extra":"auto_increment","IsAllowNull":"NO","IsPk":"YES","Index":"PRI"}]},"Success":"true"}

错误码

HttpCode错误码错误信息描述
HttpCode 错误码 错误信息 描述
500 InternalError The request processing has failed due to some unknown error. 请求失败，内部错误

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