tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CheckDataEngineConfigPairsValidity

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

1. API Description

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

This API is used to check the validity of the engine's user-defined parameters.

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: CheckDataEngineConfigPairsValidity.
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.
ChildImageVersionId No String ID of the minor version of the engine
DataEngineConfigPairs.N No Array of DataEngineConfigPair User-defined parameters
ImageVersionId No String ID of the major version of the engine. If there is the ID of the minor version, only the ID of the minor version needs to be input. If not, the latest ID of the minor version under the major version will be acquired.

3. Output Parameters

Parameter Name Type Description
IsAvailable Boolean Validity of parameters. true: valid; false: There is at least one invalid parameter.
UnavailableConfig Array of String Collection of invalid parameters
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 Checking the Validity of the Engine's User-Defined Parameters

This example shows you how to check the validity of the engine's user-defined parameters.

Input Example

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

{
    "ChildImageVersionId": "b8sddsad7-ekd4-4e5e-993e-e5db64fa21c1",
    "ImageVersionId": "",
    "DataEngineConfigPairs": [
        {
            "ConfigItem": "key",
            "ConfigValue": "value"
        }
    ]
}

Output Example

{
    "Response": {
        "IsAvailable": true,
        "UnavailableConfig": [
            "key"
        ],
        "RequestId": "b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1"
    }
}

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 The parameter is incorrect.
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.ImageStateNotMatch The specified state does not match. Currently, it only supports 1: initializing, 2: online, 3: offline.
InvalidParameter.ImageUserRecordsTypeNotMatch The specified cluster image UserRecords does not match. Currently, it only supports: 1: parentVersion; 2: childVersion; 3: pySpark.
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 The resource does not exist.
ResourceNotFound.ImageVersionNotFound The specified cluster image version does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy