tencent cloud

Tencent Cloud TCHouse-P

Release Notes
Product Introduction
Overview
Use Cases
Node Specification
Cluster Architecture
Purchase Guide
Billing Overview
Purchase Methods
Payment Overdue
Getting Started
Operation Guide
Managing Cluster
Accessing Data Warehouse
Monitoring and Alarming
Access Management
Performance Metrics
TPC-B
Tools and Downloads
Data Ingestion
Importing TencentDB Data Offline with DataX
Syncing Incremental Data from MySQL with DataX
Importing and Exporting COS Data at High Speed with External Table
Syncing EMR Data with External Table
Implementing CDWPG UPSERT with Rule
Data Warehouse Development
Creating Airflow in Cloud
API Documentation
History
Introduction
API Category
Making API Requests
Information Query APIs
Instance APIs
Query APIs
Cluster Management APIs
Cluster Operation APIs
Data Types
Error Codes
Practical Tutorial
Data Warehouse Table Development
Table Distribution Key Selection
Table Storage Format Selection
Table Partition Usage
Extension Usage
Cold Data Backup
Statistics and Space Maintenance
FAQs
Tencent Cloud TCHouse-P Policy
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us

ScaleOutInstance

PDF
Focus Mode
Font Size
Last updated: 2025-11-13 20:52:59

1. API Description

Domain name for API request: cdwpg.intl.tencentcloudapi.com.

This API is used to scale out instance.

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: ScaleOutInstance.
Version Yes String Common Params. The value used for this API: 2020-12-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String InstanceId.
NodeType Yes String Node type.
ScaleOutCount Yes Integer Number of scale-out nodes.

3. Output Parameters

Parameter Name Type Description
FlowId String FlowId.
ErrorMsg String Error message.

Note: This field may return null, indicating that no valid values can be obtained.
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 Scale Out Instance

Scale Out Instance

Input Example

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

{
    "InstanceId": "cdwpg-abcxxxxx",
    "NodeType": "dn",
    "ScaleOutCount": 2
}

Output Example

{
    "Response": {
        "FlowId": "1324",
        "ErrorMsg": "",
        "RequestId": "abcds-xxxss"
    }
}

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.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback