tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateUserDataEngineConfig

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

1. API Description

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

This API is used to modify the custom configuration of the user's engine.

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: UpdateUserDataEngineConfig.
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.
DataEngineId Yes String Engine ID
DataEngineConfigPairs.N No Array of DataEngineConfigPair Collection of user-defined engine configuration items. This parameter needs to input all the configuration items users should add. For example, if there is a configuration item named k1:v1 while k2:v2 needs to be added, [k1:v1,k2:v2] should be passed.
SessionResourceTemplate No SessionResourceTemplate Template of the resource configuration of the job engine

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 Modifing User Cluster Custom Configuration

This example shows you how to modify user cluster custom configuration.

Input Example

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

{
    "DataEngineId": "abc",
    "DataEngineConfigPairs": [
        {
            "ConfigItem": "abc",
            "ConfigValue": "abc"
        }
    ],
    "SessionResourceTemplate": {
        "DriverSize": "abc",
        "ExecutorSize": "abc",
        "ExecutorNums": 1,
        "ExecutorMaxNumbers": 1
    }
}

Output Example

{
    "Response": {
        "RequestId": "asdfwdsf"
    }
}

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 The operation failed.
InternalError An internal error occurred.
InternalError.InternalSystemException The business system is abnormal. Please try again or submit a ticket to contact us.
InvalidParameter.DataEngineConfigPairsDuplicate The specified cluster parameter already exists
InvalidParameter.ImageEngineTypeNotMatch The specified engine type does not match. Currently, only SparkSQL, PrestoSQL, and SparkBatch are supported.
InvalidParameter.ImageIsPublicNotMatch The specified isPublic does not match. Currently, it only supports 1: public and 2: private.
InvalidParameter.ImageParameterSubmitMethodNotMatch The specified cluster image ParameterSubmitMethod does not match. Currently, only User and BackGround are supported.
InvalidParameter.ImageParameterTypeNotMatch The specified cluster image ParameterType does not match. Currently, it only supports 1: session; 2: common; 3: cluster.
InvalidParameter.InvalidDataEngineConfigPairs The specified cluster parameters are invalid. Please verify and try again.
InvalidParameter.InvalidWhiteListKey There is an error in getting an allowlist. Please try again or submit a ticket to contact us.
InvalidParameter.ParameterNotFoundOrBeNone The parameter is not found or empty.
ResourceNotFound.DataEngineConfigInstanceNotFound The specified cluster configuration instance does not exist.
ResourceNotFound.DataEngineConfigInstanceNotUnique The specified cluster configuration instance already exists.
ResourceNotFound.DataEngineNotActivity The specified cluster is not running.
ResourceNotFound.DataEngineNotFound The specified engine does not exist.
ResourceNotFound.DataEngineNotMultiVersion The specified cluster is not a multi-version type and does not support this operation.
ResourceNotFound.DataEngineNotUnique The specified engine already exists.
ResourceNotFound.DataEngineTypeOnlySupportBatch The specified cluster is not a Spark batch job type and does not support this operation.
ResourceNotFound.DefaultDataEngineNotFound No default engine can be found.
ResourceNotFound.ImageSessionConfigNotFound The specified cluster image Session configuration does not exist.
ResourceNotFound.ImageSessionConfigNotUnique The specified cluster image Session configuration already exists.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy