調用DescribeTableDetail接口查看表結構詳情。

調試

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

請求參數

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

系統規定參數。取值：DescribeTableDetail。

RegionId String 是 cn-hangzhou

實例所屬地域ID。
DBInstanceName String 是 pxc-sprcym7g7w****

實例名稱。
DbName String 是 sbtest

數據庫名。
TableName String 是 k_4

表名。

返回數據

名稱 類型 示例值 描述
Message String success

返回信息，成功返回success，錯誤返回對應錯誤碼。
RequestId String FE5D94E3-3C93-3594-95D9-AAED2A980915

唯一請求ID。
Success Boolean true

請求是否成功。
Data Object

數據結構體。
Fields Array of Field

表字段信息。
Key String k_1

字段名稱。
DataType String multi

列類型。
Column String k

列。
Extra String *

保留字段。

示例

請求示例

http(s)://[Endpoint]/?Action=DescribeTableDetail
&RegionId=cn-hangzhou
&DBInstanceName=pxc-sprcym7g7w****
&DbName=sbtest
&TableName=k_4
&公共請求參數

正常返回示例

XML格式 

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

<DescribeTableDetailResponse>
    <Message>success</Message>
    <RequestId>FE5D94E3-3C93-3594-95D9-AAED2A980915</RequestId>
    <Success>true</Success>
    <Data>
        <Fields>
            <Key>k_1</Key>
            <DataType>multi</DataType>
            <Column>k</Column>
            <Extra>*</Extra>
        </Fields>
    </Data>
</DescribeTableDetailResponse>

JSON格式 

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

{
  "Message" : "success",
  "RequestId" : "FE5D94E3-3C93-3594-95D9-AAED2A980915",
  "Success" : true,
  "Data" : {
    "Fields" : [ {
      "Key" : "k_1",
      "DataType" : "multi",
      "Column" : "k",
      "Extra" : "*"
    } ]
  }
}

錯誤碼

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