Domain name for API request: dlc.tencentcloudapi.com.
This API is used to query user-defined engine parameters.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeUserDataEngineConfig. |
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. |
Sorting | No | String | Sorting methods; desc means in reverse order; asc means in order. |
Limit | No | Integer | Quantity of returns. It is 10 by default, and the maximum value is 100. |
Offset | No | Integer | Offset, which is 0 by default. |
SortBy | No | String | Sorting fields, which support the following type: create-time |
Filters.N | No | Array of Filter | Filter criteria. The following filter types are supported. The parameter Name should be one of them. The number of values that can be filtered by each type of parameter should not be bigger than 5. app-id - String - (filtering appid) engine-id - String - (filtering engine ID) |
Parameter Name | Type | Description |
---|---|---|
DataEngineConfigInstanceInfos | Array of DataEngineConfigInstanceInfo | List of custom configuration items of the user's engine Note: This field may return null, indicating that no valid values can be obtained. |
TotalCount | Integer | Total configuration items |
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. |
This example shows you how to query user-defined engine parameters.
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserDataEngineConfig
<Common request parameters>
{
"Sorting": "abc",
"Limit": 0,
"Offset": 0,
"SortBy": "abc",
"Filters": [
{
"Name": "abc",
"Values": [
"abc"
]
}
]
}
{
"Response": {
"DataEngineConfigInstanceInfos": [
{
"DataEngineId": "abc",
"DataEngineConfigPairs": [
{
"ConfigItem": "abc",
"ConfigValue": "abc"
}
],
"SessionResourceTemplate": {
"DriverSize": "abc",
"ExecutorSize": "abc",
"ExecutorNums": 1,
"ExecutorMaxNumbers": 1
}
}
],
"TotalCount": 1,
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.DBError | A database error occurred. |
InvalidParameter | The parameter is incorrect. |
InvalidParameterValue | The parameter value is incorrect. |
この記事はお役に立ちましたか?