調用DescribeTable接口查詢table結構信息。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeTable

系統(tǒng)固定參數，取值為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，如果遇到問題請?zhí)峁┻@個請求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 錯誤碼 錯誤信息 描述
500 InternalError The request processing has failed due to some unknown error. 請求失敗，內部錯誤

訪問錯誤中心查看更多錯誤碼。