1. 接口描述
接口请求域名: cdwdoris.tencentcloudapi.com 。
针对驱动sql命令查询集群接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSqlApis。 |
Version | 是 | String | 公共参数,本接口取值:2021-12-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例id 示例值:cdwdoris-qliqegj3 |
ApiType | 是 | String | GetUsers:获取用户列表; GetDatabases:获取数据库列表; GetTables:获取数据库表列表; GetUserPrivilegesV2:获取用户下的权限,粒度到表级别; DeleteUser:删除用户; GetCatalog:获取Catalog列表; 示例值:GetClusters |
UserName | 否 | String | 用户名称 示例值:user1 |
WhiteHost | 否 | String | 用户链接来自的 IP 示例值:10.0.0.2 |
Catalog | 否 | String | catalog名称 示例值:interal |
Catalogs.N | 否 | Array of String | catalog集合 示例值:["c1"] |
DatabaseName | 否 | String | 数据库名 示例值:db_demo |
TableName | 否 | String | 表名 示例值:table_add_table1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ReturnData | String | 返回的查询数据,大部分情况是list,也可能是bool 示例值:["__internal_schema","db_demo","demo","information_schema","mysql"] |
ErrorMsg | String | 错误消息 示例值:1.2 version req must has catalog |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取数据库列表
输入示例
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSqlApis
<公共请求参数>
{
"InstanceId": "cdwdoris-qliqegj3",
"ApiType": "GetDatabases",
"Catalog": "internal"
}
输出示例
{
"Response": {
"ErrorMsg": "",
"RequestId": "267b8c6c-d8ab-440c-bd01-7f060c76d572",
"ReturnData": "[\"__internal_schema\",\"db_demo\",\"demo\",\"information_schema\",\"mysql\"]"
}
}
示例2 获取用户列表
输入示例
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSqlApis
<公共请求参数>
{
"InstanceId": "cdwdoris-qliqegj3",
"ApiType": "GetUsers"
}
输出示例
{
"Response": {
"ErrorMsg": "",
"RequestId": "5d704cb1-9cce-41b0-8841-c20318fad683",
"ReturnData": "[{\"InstanceId\":\"cdwdoris-qliqegj3\",\"UserName\":\"admin\",\"WhiteHost\":\"\",\"Describe\":\"系统用户,权限不能修改,也不能删除\",\"GlobalPriList\":null},{\"InstanceId\":\"cdwdoris-qliqegj3\",\"UserName\":\"test\",\"WhiteHost\":\"%\",\"Describe\":\"\",\"GlobalPriList\":[\"ADMIN_PRIV\"]}]"
}
}
示例3 获取数据库表列表
输入示例
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSqlApis
<公共请求参数>
{
"InstanceId": "cdwdoris-qliqegj3",
"ApiType": "GetTables",
"Catalogs": [
"internal"
]
}
输出示例
{
"Response": {
"ErrorMsg": "",
"RequestId": "4d1c7a4c-fd61-4537-a9f1-b377c9457f78",
"ReturnData": "{\"internal\":[{\"DatabaseName\":\"information_schema\",\"Tables\":[\"table_constraints\",\"referential_constraints\",\"columns\",\"schemata\",\"column_privileges\",\"column_statistics\",\"parameters\",\"statistics\",\"profiling\",\"key_column_usage\",\"global_variables\",\"table_privileges\",\"user_privileges\",\"partitions\",\"collations\",\"triggers\",\"engines\",\"active_queries\",\"metadata_name_ids\",\"files\",\"catalog_meta_cache_statistics\",\"processlist\",\"events\",\"table_properties\",\"session_variables\",\"workload_group_resource_usage\",\"rowsets\",\"file_cache_statistics\",\"views\",\"character_sets\",\"workload_groups\",\"workload_policy\",\"workload_group_privileges\",\"routines\",\"schema_privileges\",\"tables\",\"table_options\",\"backend_active_tasks\"]},{\"DatabaseName\":\"demo\",\"Tables\":[\"add_table2\"]},{\"DatabaseName\":\"__internal_schema\",\"Tables\":[\"audit_log\",\"column_statistics\",\"histogram_statistics\"]},{\"DatabaseName\":\"mysql\",\"Tables\":[\"procs_priv\",\"user\"]},{\"DatabaseName\":\"db_demo\",\"Tables\":[]}]}"
}
}
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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。