预览表内容

功能介绍

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

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}

请求消息

无请求参数。

响应消息

请求示例

无

响应示例

同步请求成功响应样例：

{
       "is_success": true,
       "message": "",
       "schema": [    
           {      
             "id": "int"
           },
           {      
             "name": "string"
           },
           {      
             "address": "string"
           }  
        ],
        "rows": [
           [
               "1",
               "John",
               "xxx"
           ],
           [
               "2",
               "Lily",
               "xxx"
           ]
       ]
    }

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

状态码

状态码如表4所示。

错误码

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