腾讯云数据仓库 TCHouse-P 集群配置描述-查询相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cdwpg.tencentcloudapi.com 。

配置描述

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBParams。
Version	是	String	公共参数，本接口取值：2020-12-30。
Region	是	String	公共参数，详见产品支持的地域列表。
NodeTypes.N	否	Array of String	cn/dn 示例值：cn/dn
Limit	否	Integer	range::(0,100] 示例值：1
Offset	否	Integer	range::[0,INF) 示例值：1
InstanceId	否	String	InstanceId名称示例值：1

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总数示例值：1
Items	Array of ParamItem	参数信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 1

输入示例

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

{
    "InstanceId": "cdwpg-xx",
    "Limit": 20,
    "NodeTypes": [
        "dn"
    ],
    "Offset": 0
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "xxss",
        "Items": [
            {
                "NodeType": "cn",
                "NodeName": "cn001",
                "TotalCount": 2,
                "Details": [
                    {
                        "ParamName": "MaxConnections",
                        "DefaultValue": "100",
                        "NeedRestart": false,
                        "RunningValue": "100",
                        "ValueRange": {
                            "Type": "enum",
                            "Enum": [
                                "DEBUG",
                                "INFO",
                                "WARN",
                                "ERROR"
                            ],
                            "Range": {
                                "Min": "1024",
                                "Max": "4096"
                            },
                            "String": ""
                        },
                        "Unit": "connections",
                        "ShortDesc": "Maximum number of concurrent connections",
                        "ParameterName": "cds"
                    }
                ]
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

集群配置描述

本页目录：