Previewing Table Content (Discarded)¶
Function¶
This API is used to preview the first 10 rows in a table.
Note
This API has been discarded and is not recommended.
URI¶
URI format
GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/preview
Parameter description
Table 1 URI parameters¶ Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.
database_name
Yes
String
Name of the database where the table to be previewed resides.
table_name
Yes
String
Name of the table to be previewed.
Table 2 query parameter description¶ Parameter
Mandatory
Type
Description
mode
No
String
Preview table mode. The options are SYNC and ASYNC. The default value is SYNC.
Note
The following is an example of the URL containing the query parameter:
GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/preview?mode={previewMode}
Request¶
None
Response¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
is_success | No | Boolean | Whether the request is successfully executed. Value true indicates that the request is successfully executed. |
message | No | String | System prompt. If execution succeeds, the parameter setting may be left blank. |
schema | No | Array of Map | Column name and type of a table. |
rows | No | Array of objects | Previewed table content. |
Example Request¶
None
Example Response¶
The following is an example of a successful response in synchronous mode:
{
"is_success": true,
"message": "",
"schema": [
{
"id": "int"
},
{
"name": "string"
},
{
"address": "string"
}
],
"rows": [
[
"1",
"John",
"xxx"
],
[
"2",
"Lily",
"xxx"
]
]
}
Note
In asynchronous request mode, a job ID is returned. You can obtain the preview information based on the job ID.
Status Codes¶
Table 4 describes the status code.
Status Code | Description |
|---|---|
200 | The query is successful. |
400 | Request error. |
500 | Internal service error. |
Error Codes¶
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.