API参考—数据库管理—DescribeTableDetail

本文涉及的产品
云原生数据库 PolarDB 分布式版,标准版 2核8GB
简介: 调用DescribeTableDetail接口查看表结构详情。

调试

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


请求参数

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

系统规定参数。取值为DescribeTableDetail

DBInstanceName String pxc-****************

实例ID。

DbName String db2

数据库名称。

RegionId String cn-hangzhou

实例所在地域。

TableName String test

目标表名称。

返回数据

名称 类型 示例值 描述
Data Struct

表信息。

Message String ****

请求返回消息。

说明 请求成功时该参数为空,请求失败时会返回请求异常信息(如错误码等)。

RequestId String C606E5AC-DD01-4515-BDC4-299A9******

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例


http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeTableDetail
&DBInstanceName=pxc-****************
&DbName=db2
&RegionId=cn-hangzhou
&TableName=test
&<公共请求参数>

正常返回示例

XML 格式


<code>200</code>
<data>
    <RequestId>C606E5AC-DD01-4515-BDC4-299A9******</RequestId>
    <Message/>
    <Data>
        <Fields>
            <Extra/>
            <Column>Address</Column>
            <DataType>varchar(20)</DataType>
            <Key/>
        </Fields>
        <Fields>
            <Extra>auto_increment</Extra>
            <Column>Id</Column>
            <DataType>bigint(20)</DataType>
            <Key>PRI</Key>
        </Fields>
        <Fields>
            <Extra/>
            <Column>Name</Column>
            <DataType>varchar(20)</DataType>
            <Key/>
        </Fields>
    </Data>
    <Success>true</Success>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>C606E5AC-DD01-4515-BDC4-299A9******</requestId>
<successResponse>true</successResponse>

JSON 格式


{
  "code": "200",
  "data": {
    "RequestId": "C606E5AC-DD01-4515-BDC4-299A9******",
    "Message": "",
    "Data": {
      "Fields": [{
        "Extra": "",
        "Column": "Address",
        "DataType": "varchar(20)",
        "Key": ""
      }, {
        "Extra": "auto_increment",
        "Column": "Id",
        "DataType": "bigint(20)",
        "Key": "PRI"
      }, {
        "Extra": "",
        "Column": "Name",
        "DataType": "varchar(20)",
        "Key": ""
      }]
    },
    "Success": true
  },
  "httpStatusCode": "200",
  "requestId": "C606E5AC-DD01-4515-BDC4-299A9******",
  "successResponse": true
}
相关实践学习
快速体验PolarDB开源数据库
本实验环境已内置PostgreSQL数据库以及PolarDB开源数据库:PolarDB PostgreSQL版和PolarDB分布式版,支持一键拉起使用,方便各位开发者学习使用。
相关文章
|
6月前
|
Prometheus 网络协议 JavaScript
api 网关 kong 数据库记录请求响应报文
Kong的tcp-log-with-body插件是一个高效的工具,它能够转发Kong处理的请求和响应。这个插件非常适用于需要详细记录API请求和响应信息的情景,尤其是在调试和排查问题时。
177 0
api 网关 kong 数据库记录请求响应报文
|
6月前
|
API 数据库 C语言
【C/C++ 数据库 sqlite3】SQLite C语言API返回值深入解析
【C/C++ 数据库 sqlite3】SQLite C语言API返回值深入解析
270 0
|
小程序 JavaScript API
小程序云开发实战五:如何将获取到的API数据存入云数据库里面
小程序云开发实战五:如何将获取到的API数据存入云数据库里面
137 0
|
3月前
|
API Java 数据库连接
从平凡到卓越:Hibernate Criteria API 让你的数据库查询瞬间高大上,彻底告别复杂SQL!
【8月更文挑战第31天】构建复杂查询是数据库应用开发中的常见需求。Hibernate 的 Criteria API 以其强大和灵活的特点,允许开发者以面向对象的方式构建查询逻辑,同时具备 SQL 的表达力。本文将介绍 Criteria API 的基本用法并通过示例展示其实际应用。此 API 通过 API 构建查询条件而非直接编写查询语句,提高了代码的可读性和安全性。无论是简单的条件过滤还是复杂的分页和连接查询,Criteria API 均能胜任,有助于提升开发效率和应用的健壮性。
107 0
|
3月前
|
存储 开发框架 .NET
ASP.NET Web Api 使用 EF 6,DateTime 字段如何取数据库服务器当前时间
ASP.NET Web Api 使用 EF 6,DateTime 字段如何取数据库服务器当前时间
|
4月前
|
数据可视化 安全 API
数据库开放权限风险高,API非唯一选择:DataV为您开启安全高效的数据可视化之旅
良好的用户体验:DataV注重用户体验设计,提供了丰富的交互效果和动画效果,使得数据可视化大屏更加生动、吸引人。这有助于提升用户的参与度和满意度,促进数据的广泛应用
|
5月前
|
DataWorks Oracle 数据库连接
DataWorks产品使用合集之如何实现数据集成接入提供ODBC API的Oracle数据库
DataWorks作为一站式的数据开发与治理平台,提供了从数据采集、清洗、开发、调度、服务化、质量监控到安全管理的全套解决方案,帮助企业构建高效、规范、安全的大数据处理体系。以下是对DataWorks产品使用合集的概述,涵盖数据处理的各个环节。
54 0
|
6月前
|
前端开发 API 数据库
Django(五):如何在Django中通过API提供数据库数据给前端
Django(五):如何在Django中通过API提供数据库数据给前端
191 9
|
6月前
|
SQL Java 数据库连接
JDBC Java标准库提供的一些api(类+方法) 统一各种数据库提供的api
JDBC Java标准库提供的一些api(类+方法) 统一各种数据库提供的api
48 0
|
6月前
|
SQL 关系型数据库 API
从API获取数据并将其插入到PostgreSQL数据库:步骤解析
使用Python处理从API获取的数据并插入到PostgreSQL数据库:安装`psycopg2`,建立数据库连接,确保DataFrame与表结构匹配,然后使用`to_sql`方法将数据插入到已存在的表中。注意数据准备、权限设置、性能优化和安全处理。
下一篇
无影云桌面