1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
开通微信云托管MySQL数据库服务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateWxCloudBaseRunServerDBCluster。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
AccountPassword | 是 | String | 账户密码 示例值:"123456" |
EnvId | 是 | String | 环境ID 示例值:"test" |
WxAppId | 否 | String | 微信appid 示例值:"wx-appid" |
DbVersion | 否 | String | mysql内核版本,支持5.7,8.0 示例值:5.7 |
LowerCaseTableName | 否 | String | 0: 大小写敏感 1: 非大小写敏感 默认为0 示例值:“1” |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 success
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWxCloudBaseRunServerDBCluster
<公共请求参数>
{
"DbVersion": "字符串",
"WxAppId": "字符串",
"EnvId": "字符串",
"AccountPassword": "字符串"
}
输出示例
{
"Response": {
"RequestId": "e1210cbf-f738-47f7-8e6d-2af814acece6"
}
}
示例2 success-20221010
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWxCloudBaseRunServerDBCluster
<公共请求参数>
{
"DbVersion": "字符串",
"WxAppId": "字符串",
"EnvId": "字符串",
"LowerCaseTableName": "字符串",
"AccountPassword": "字符串"
}
输出示例
{
"Response": {
"RequestId": "e1faa7da-a58b-44e1-9647-4782d8c11321"
}
}
示例3 开通微信云托管MySQL服务实例
在微信云托管后台,用户开通MySQL时需要调用
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWxCloudBaseRunServerDBCluster
<公共请求参数>
{
"EnvId": "env-test",
"AccountPassword": "pwd-test",
"DbVersion": "5.7"
}
输出示例
{
"Response": {
"RequestId": "asdasda-asfdafs"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.Database | 数据库错误。 |
InternalError.SystemFail | 系统失败。 |
InternalError.Timeout | 服务超时。 |
InvalidParameter | 参数错误。 |
InvalidParameter.EnvId | 环境ID非法。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.Request | 请求次数超过配额限制。 |
ResourceUnavailable | 资源不可用。 |
UnsupportedOperation.TaskExisted | 有正在进行中的任务。 |