PolarDB-X 1.0-API參考-1.0（2019版本）-資料表管理-DescribeTable

請求參數

名稱	類型	是否必選	示例值	描述
Action	String	是	DescribeTable	系統規定參數。取值：DescribeTable。
DbName			drds_flashback	資料庫名
DrdsInstanceId			drdshbga76p61861	DRDS執行個體Id
TableName			employee_split	表名
RegionId		否	cn-hangzhou

傳回資料

Data
RequestId		5DC75BC2-3F3F-4FE5-8DC9-2A808B9AA401	請求唯一ID，如果遇到問題請提供這個請求ID，由從業人員為您排查。
Success	Boolean	true	目前API是否請求成功

示例

請求示例

http(s)://[Endpoint]/?Action=DescribeTable
&<公共請求參數>      

正常傳回示例

XML

格式

<DescribeTableResponse>
      <code>200</code>
      <data>
            <RequestId>5DC75BC2-3F3F-4FE5-8DC9-2A808B9AA401</RequestId>
            <Data>
                  <List>
                        <ColumnName>Id</ColumnName>
                        <ColumnType>bigint(20)</ColumnType>
                        <Extra>auto_increment</Extra>
                        <IsAllowNull>NO</IsAllowNull>
                        <IsPk>YES</IsPk>
                        <Index>PRI</Index>
                  </List>
                  <List>
                        <ColumnName>Name</ColumnName>
                        <ColumnType>varchar(20)</ColumnType>
                        <Extra></Extra>
                        <IsAllowNull>NO</IsAllowNull>
                        <IsPk>NO</IsPk>
                        <Index></Index>
                  </List>
                  <List>
                        <ColumnName>Address</ColumnName>
                        <ColumnType>varchar(20)</ColumnType>
                        <Extra></Extra>
                        <IsAllowNull>NO</IsAllowNull>
                        <IsPk>NO</IsPk>
                        <Index></Index>
                  </List>
            </Data>
            <Success>true</Success>
      </data>
      <requestId>5DC75BC2-3F3F-4FE5-8DC9-2A808B9AA401</requestId>
      <successResponse>true</successResponse>
</DescribeTableResponse>      

JSON

{
    "successResponse":true,
    "requestId":"5DC75BC2-3F3F-4FE5-8DC9-2A808B9AA401",
    "data":{
        "Data":{
            "List":[
                {
                    "IsPk":"YES",
                    "Extra":"auto_increment",
                    "Index":"PRI",
                    "IsAllowNull":"NO",
                    "ColumnType":"bigint(20)",
                    "ColumnName":"Id"
                },
                {
                    "IsPk":"NO",
                    "Extra":"",
                    "Index":"",
                    "IsAllowNull":"NO",
                    "ColumnType":"varchar(20)",
                    "ColumnName":"Name"
                },
                {
                    "IsPk":"NO",
                    "Extra":"",
                    "Index":"",
                    "IsAllowNull":"NO",
                    "ColumnType":"varchar(20)",
                    "ColumnName":"Address"
                }
            ]
        },
        "RequestId":"5DC75BC2-3F3F-4FE5-8DC9-2A808B9AA401",
        "Success":true
    },
    "code":"200"
}      

錯誤碼

通路

錯誤中心

檢視更多錯誤碼。