1. 接口描述
此接口处于预下线状态 。
预计下线时间:2023-06-19 11:57:40
接口请求域名: cdb.tencentcloudapi.com 。
该接口不再维护,参考CreateDBInstance+API文档,在发货时即可完成初始化。
本接口(InitDBInstances)用于初始化云数据库实例,包括初始化密码、默认字符集、实例端口号等。该接口已经废弃,在发货接口CreateDBInstance、CreateDBInstanceHour可以直接使用参数Password设置密码,使用参数ParamList设置字符集,使用参数Port设置端口号。
默认接口请求频率限制:100次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:InitDBInstances。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 是 | Array of String | 实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 InstanceId 的值。 示例值:["cdb-f35wr6wj\r\n"] |
NewPassword | 是 | String | 实例新的密码,密码规则:8-64个字符,至少包含字母、数字、字符(支持的字符:!@#$%^*())中的两种。 示例值:Gx18ux23F^X |
Parameters.N | 是 | Array of ParamInfo | 实例的参数列表,目前支持设置“character_set_server”、“lower_case_table_names”参数。其中,“character_set_server”参数可选值为["utf8","latin1","gbk","utf8mb4"];“lower_case_table_names”可选值为[“0”,“1”]。 |
Vport | 否 | Integer | 实例的端口,取值范围为[1024, 65535] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AsyncRequestIds | Array of String | 异步任务的请求ID数组,可使用此ID查询异步任务的执行结果 示例值:["8cd119d4-61ba-11e7-aeff-018cfa1f5560"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 初始化新实例
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InitDBInstances
<公共请求参数>
{
"NewPassword": "xx",
"Vport": 0,
"Parameters": [
{
"Name": "lower_case_table_names",
"Value": "1"
},
{
"Name": "character_set_server",
"Value": "utf8"
}
],
"InstanceIds": [
"cdb-f35wr6wj"
]
}
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"AsyncRequestIds": [
"8cd119d4-61ba-11e7-aeff-018cfa1f5560"
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.UndefinedError | 未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InstanceNotFound | 实例不存在。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.UserHasNoStrategy | 用户没有该策略权限。 |
OperationDenied.WrongPassword | 密码错误或校验未通过。 |