tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeUpdatableDataEngines

最后更新时间：2024-08-08 15:32:53

1. API Description

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

This API is used to query the list of engines that are able to upgrade their 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: DescribeUpdatableDataEngines.
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.
DataEngineConfigCommand Yes String Operation commands of engine configuration. UpdateSparkSQLLakefsPath updates the path of managed tables, and UpdateSparkSQLResultPath updates the path of result buckets.
UseLakeFs No Boolean
CustomResultPath No String

3. Output Parameters

Parameter Name Type Description
DataEngineBasicInfos Array of DataEngineBasicInfo Basic cluster information
TotalCount Integer Number of clusters
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 Querying the sparksql Engine That Needs to Update the Result Bucket Cluster Configuration

This example shows you how to query the sparksql engine that needs to update the result bucket cluster configuration.

Input Example

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

{
    "DataEngineConfigCommand": "UpdateSparkSQLResultPath"
}

Output Example

{
    "Response": {
        "DataEngineBasicInfos": [
            {
                "DataEngineName": "abc",
                "State": 0,
                "CreateTime": 0,
                "UpdateTime": 0,
                "Message": "abc",
                "DataEngineId": "abc",
                "DataEngineType": "abc",
                "AppId": 0,
                "UserUin": "abc"
            }
        ],
        "TotalCount": 0,
        "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.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidDataEngineDescription The engine description information is invalid.
InvalidParameter.InvalidEngineExecType The engine execution type is invalid.
InvalidParameterValue The parameter value is incorrect.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款