tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateDataEngine

Last updated: 2024-08-08 15:32:48

1. API Description

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

This API is used to upgrade data engine configuration.

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: UpdateDataEngine.
Version Yes String Common Params. The value used for this API: 2021-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Size Yes Integer Resource size
MinClusters Yes Integer Minimum CU resource
MaxClusters Yes Integer Maximum CU resource
AutoResume Yes Boolean Enable the auto-refresh. True means that it is enabled while false means that it is disabled (by default).
DataEngineName Yes String Data engine name
Message Yes String Related information
AutoSuspend No Boolean Whether to automatically suspend the cluster. False means no (by default) while true means yes.
CrontabResumeSuspend No Integer Scheduling policy of starting and ending the cluster: 0 (by default) indicates disabling the scheduling policy; 1 indicates enabling the scheduling policy. (Note: The scheduling policy and the automatic suspension policy are mutually exclusive.)
CrontabResumeSuspendStrategy No CrontabResumeSuspendStrategy Scheduling policy for the start and end; the complex type includes start and end time and the cluster suspension policy.
MaxConcurrency No Integer The maximum number of concurrent tasks for a single cluster, which is 5 by default.
TolerableQueueTime No Integer Tolerable queuing time, and it is 0 by default. When the queuing time for tasks exceeds the tolerable time, it may trigger scale-out. If this parameter is 0, it means that scale-out may be triggered immediately once tasks start queuing.
AutoSuspendTime No Integer Cluster automatic suspension time
ElasticSwitch No Boolean Whether the AS of the spark jar monthly subscription cluster is enabled
ElasticLimit No Integer Upper limit of the spark jar monthly subscription cluster elastic scaling
SessionResourceTemplate No SessionResourceTemplate Session resource configuration template of Spark batch job clusters

3. Output Parameters

Parameter Name Type Description
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 Changing the Engine Configuration

This example shows you how to change the engine configuration.

Input Example

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

{
    "MaxClusters": 0,
    "CrontabResumeSuspend": 0,
    "AutoSuspend": true,
    "CrontabResumeSuspendStrategy": {
        "SuspendTime": "0",
        "SuspendStrategy": 0,
        "ResumeTime": "0"
    },
    "AutoResume": true,
    "DataEngineName": "test",
    "Message": "modify",
    "MinClusters": 0,
    "Size": 0
}

Output Example

{
    "Response": {
        "RequestId": "xx-xxxx-xxx-xxxx"
    }
}

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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.AbnormalOrderStatus Order status exception.
FailedOperation.AnotherProcessRunning Another operation is in progress. Please try again later.
FailedOperation.AnotherRequestProcessing Another request is being processed. Try again later.
FailedOperation.BalanceNotEnough Insufficient account balance.
FailedOperation.BillingSystemError Billing system exception.
FailedOperation.DeliverGoodsFailed Failed to deliver the goods.
FailedOperation.FeeDeductionFailed Deduction failed.
FailedOperation.GetProductInformationFailed Failed to get product information.
FailedOperation.ModifyInstanceFailed Failed to scale up/down the instance.
FailedOperation.NumberExceedLimit Reached the allowed limit of engines.
FailedOperation.ParameterValidationFailed Failed to verify parameters.
FailedOperation.RefundDepositFailed Refunding failed.
FailedOperation.TooManyResources The number of resources reached the limit.
InternalError An internal error occurred.
InternalError.InternalSystemException The business system is abnormal. Please try again or submit a ticket to contact us.
InvalidParameter The parameter is incorrect.
InvalidParameter.InstanceInProcess Instances are in other processes.
InvalidParameter.InvalidDataEngineDescription The engine description information is invalid.
InvalidParameter.InvalidDataEngineMode Invalid data engine mode.
InvalidParameter.InvalidDataEngineName The data engine name is invalid.
InvalidParameter.InvalidDataEngineSpecs Invalid data engine spec.
InvalidParameter.InvalidDefaultDataEngine The default data engine parameters are invalid.
InvalidParameter.InvalidDescription The description information is invalid.
InvalidParameter.InvalidMinClusters The minimum number of clusters is invalid.
InvalidParameter.InvalidSQL SQL parsing failed.
ResourceInUse.UnfinishedSQLs Some SQL tasks have not yet been completed.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.ModifyComputingEngine Sub-users cannot modify engine configuration.
UnauthorizedOperation.NoPaymentAuthority No permission to pay.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy