tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ExecuteSelectQuery

Last updated: 2024-09-14 11:01:30

1. API Description

Domain name for API request: cdwdoris.tencentcloudapi.com.

This API is used to query data according to the specified database and table name, and support field selection and pagination.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ExecuteSelectQuery.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
Database Yes String Database name
Query Yes String SQL query statements only support select statements.
InstanceId Yes String InstanceId
PageNum No Integer Page number, which is 1 by default.
PageSize No Integer Number of records per page, which is 10 by default.
UserName No String Use the user who has corresponding permissions for operations. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.
PassWord No String Password corresponding to the user. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.
CatalogName No String Catalog name, defaults to 'internal' if not specified.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total records of query results
Fields Array of String Field name array of query results
FieldTypes Array of String Field type array of query results
Rows Array of Rows Returned data record array. Each element is an array, containing the value of the corresponding field.
Message String Error message
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying According to SQL

Input Example

POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExecuteSelectQuery
<Common request parameters>

{
   "InstanceId": "cdwdoris-xxx",
    "Database": "demo1",
    "Query": "SELECT * FROM my_table LIMIT 10 OFFSET 0;"

}

Output Example

{
    "Response": {
        "Fields": [
            "id",
            "name",
            "age",
            "salary",
            "join_date"
        ],
        "Rows": [
            {
                "DataRow": [
                    "11",
                    "John Doe",
                    "30",
                    "7000.50000",
                    "2024-08-27 00:00:00 +0800 CST"
                ]
            },
            {
                "DataRow": [
                    "21",
                    "Jane Smith",
                    "25",
                    "6000.00000",
                    "2024-08-28 00:00:00 +0800 CST"
                ]
            },
            {
                "DataRow": [
                    "11",
                    "John Doe",
                    "30",
                    "7000.50000",
                    "2024-08-27 00:00:00 +0800 CST"
                ]
            },
            {
                "DataRow": [
                    "21",
                    "Jane Smith",
                    "25",
                    "6000.00000",
                    "2024-08-28 00:00:00 +0800 CST"
                ]
            }
        ],
        "RequestId": "xx-xx-xx-xx-xx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy