查询用户自定义引擎参数

最近更新时间:2024-09-06 01:29:10

我的收藏

1. 接口描述

接口请求域名: dlc.tencentcloudapi.com 。

查询用户自定义引擎参数

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUserDataEngineConfig。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
Sorting String 排序方式,desc表示倒序,asc表示正序
Limit Integer 返回数量,默认为10,最大值为100。
Offset Integer 偏移量,默认为0。
SortBy String 排序字段,支持如下字段类型,create-time
Filters.N Array of Filter 过滤条件,如下支持的过滤类型,传参Name应为以下其中一个,每种过滤参数支持的过滤值不超过5个。
app-id - String - (appid过滤)
engine-id - String - (引擎ID过滤)

3. 输出参数

参数名称 类型 描述
DataEngineConfigInstanceInfos Array of DataEngineConfigInstanceInfo 用户引擎自定义配置项列表。
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 配置项总数。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询用户自定义引擎参数

查询用户自定义引擎参数

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserDataEngineConfig
<公共请求参数>

{
    "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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.DBError 数据库错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。