初始化新实例

最近更新时间:2018-10-26 15:05:17

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(InitDBInstances)用于初始化云数据库实例,包括初始化密码、默认字符集、实例端口号等

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cdb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:InitDBInstances
Version String 公共参数,本接口取值:2017-03-20
Region String 公共参数,详见产品支持的地域列表
InstanceIds.N Array of String 实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 InstanceId 的值。
NewPassword String 实例新的密码,密码规则:8-64个字符,至少包含字母、数字、字符(支持的字符:!@#$%^*())中的两种。
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查询异步任务的执行结果
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 初始化新实例

输入示例

https://cdb.tencentcloudapi.com/?Action=InitDBInstances
&InstanceIds.0=cdb-f35wr6wj
&NewPassword=Gx18ux23F^X
&Parameters.0.name=lower_case_table_names
&Parameters.0.value=1
&Parameters.1.name=character_set_server
&Parameters.1.value=utf8
&<公共请求参数>

输出示例

{
  "Response": {
    "AsyncRequestIds": [
      "8cd119d4-61ba-11e7-aeff-018cfa1f5560"
    ],
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InvalidParameter 参数错误。