更新时间:2022-04-16 GMT+08:00
分享

预览表内容

功能介绍

该API用于用于预览表中前10行的内容。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

    GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/preview

  • 参数说明
    表1 URI 参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    database_name

    String

    待预览的表所在的数据库名称。

    table_name

    String

    待预览的表名称。

    表2 query参数

    参数名称

    是否必选

    参数类型

    说明

    mode

    String

    预览表的模式,取值为““SYNC””或者““ASYNC””默认值为:“SYNC”。

    带入query参数的URL示例如下:

    GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/preview?mode={previewMode}

请求消息

无请求参数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

schema

Array of objects

表的列名称和类型。

rows

Array of strings

预览的表内容。

示例

  • 同步请求样例:
    NONE
  • 同步请求成功响应样例:
    {
           "is_success": true,
           "message": "",
           "schema": [    
               {      
                 "id": "int"
               },
               {      
                 "name": "string"
               },
               {      
                 "address": "string"
               }  
            ],
           "rows": [
               {
                   "1",
                   "John",
                   "Shanghai"
               },
               {
                   "2",
                   "Lily",
                   "Hangzhou"
               }
           ]
        }

    如果为异步请求模式,则返回一个job ID,用户可再根据job ID获取预览信息。

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

关闭导读