tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateDataEngineConfig

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

1. API Description

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

This API is used to trigger the modification of the engine configuration by the user through a certain operation.

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: UpdateDataEngineConfig.
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.
DataEngineIds.N Yes Array of String Engine ID
DataEngineConfigCommand Yes String Commands of engine configuration. UpdateSparkSQLLakefsPath (updates the configuration of the native table) and UpdateSparkSQLResultPath (updates the configuration of the result path) are supported.
UseLakeFs No Boolean Whether to use lakeFS as result storage
CustomResultPath No String User-defined result path

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 Updating the Result Bucket Configuration Information for the Specified Engine

This example shows you how to update the result bucket configuration information for the specified engine.

Input Example

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

{
    "DataEngineIds": [
        "DataEngine-xxx"
    ],
    "DataEngineConfigCommand": "UpdateSparkSQLResultPath"
}

Output Example

{
    "Response": {
        "RequestId": "abc"
    }
}

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.
FailedOperation.NoPermissionToUseTheDataEngine The user does not have permission to specify the engine.
InternalError An internal error occurred.
InternalError.InternalSystemException The business system is abnormal. Please try again or submit a ticket to contact us.
InvalidParameter.DataEngineExecTypeNotMatch The parameter ExecType passing to the specified cluster is invalid. Currently, only SQL or BATCH is supported.
InvalidParameter.DataEnginePayModeTypeNotMatch The specified cluster payment type does not match. Currently, it only supports 0: postpaid and 1: prepaid.
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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy