获取table结构信息

调试

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

请求参数

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

系统规定参数。取值：DescribeTable。
DbName String 是 drds_flashback

数据库名
DrdsInstanceId String 是 drdshbga76p61861

DRDS实例Id
TableName String 是 employee_split

表名
RegionId String 否 cn-hangzhou

RegionId

返回数据

名称 类型 示例值 描述
Data

返回数据
List

返回数据集合
ColumnName String Id

列名
ColumnType String bigint(20)

列类型
Extra String auto_increment

Extra
Index String PRI

主键
IsAllowNull String NO

是否允许为空
IsPk String YES

是否为主键
RequestId String 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"
}

错误码

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