1. 接口描述
接口请求域名: cdwch.tencentcloudapi.com 。
查询集群用户、集群表,数据库等相关信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCkSqlApis。 |
Version | 是 | String | 公共参数,本接口取值:2020-09-15。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例id 示例值:cdwch-xxxxxxxx |
ApiType | 是 | String | api接口名称,GetClusters:获取集群cluster列表 GetSystemUsers:获取系统用户列表 CheckNodeCluster: 检查节点是否隶属一个cluster GetClusterDatabases: 获取一个cluster下的数据库列表 GetClusterTables: 获取一个cluster下的数据库表列表 GetPrivilegeUsers: 获取授权的用户列表 GET_USER_CLUSTER_PRIVILEGES:获取用户cluster下的权限 GetUserClusterNewPrivileges:获取用户cluster下的权限 (新版) RevokeClusterUser:解绑cluster用户 DeleteSystemUser:删除系统用户 —— 必须所有cluster先解绑 GetUserOptionMessages:获取用户配置备注信息 GET_USER_CONFIGS:获取用户配置列表 QUOTA、PROFILE、POLICY 示例值:GetClusters |
Cluster | 否 | String | 集群名称,GET_SYSTEM_USERS,GET_PRIVILEGE_USERS,GET_CLUSTER_DATABASES,GET_CLUSTER_TABLES 必填 示例值:default |
UserName | 否 | String | 用户名称,api与user相关的必填 示例值:user1 |
UserType | 否 | String | 账户的类型 示例值:XML |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ReturnData | String | 返回的查询数据,大部分情况是list,也可能是bool 示例值:[{"InstanceId":"cdwch-xxxxxxxx","UserName":"test_user","Describe":"","Type":"RBAC","Cluster":"default_cluster"}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询ck集群信息
输入示例
输出示例
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。