调用DescribeTableDetail查看表结构详情_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调试

您可以在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" : "*"
    } ]
  }
}

错误码

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