初始化实例

最近更新时间:2018-09-18 17:03:16

1. 接口描述

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

本接口 (InitDBInstances) 用于初始化云数据库PostgreSQL实例。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:InitDBInstances
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DBInstanceIdSet.N Array of String 实例ID集合。
AdminName String 实例根账号用户名。
AdminPassword String 实例根账号用户名对应的密码。
Charset String 实例字符集,目前只支持:UTF8、LATIN1。

3. 输出参数

参数名称 类型 描述
DBInstanceIdSet Array of String 实例ID集合。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 初始化单个实例

输入示例

https://postgres.tencentcloudapi.com/?Action=InitDBInstances
&DBInstanceIdSet.0=postgres-6fego161
&AdminName=testuser
&AdminPassword=testuser%40123
&Charset=UTF8
&<公共请求参数>

输出示例

{
  "Response": {
    "DBInstanceIdSet": [
      "postgres-6fego161"
    ],
    "RequestId": "98fe67de-f7a7-4285-b1f2-40c2a2a3495e"
  }
}

示例2 初始化多个实例

输入示例

https://postgres.tencentcloudapi.com/?Action=InitDBInstances
&Version=2017-03-12
&Region=ap-guangzhou
&DBInstanceIdSet.0=postgres-6fego161
&DBInstanceIdSet.1=postgres-lnp6j617
&AdminName=testuser
&AdminPassword=testuser%40123
&Charset=UTF8
&<公共请求参数>

输出示例

{
  "Response": {
    "DBInstanceIdSet": [
      "postgres-6fego161",
      "postgres-lnp6j617"
    ],
    "RequestId": "5b895b34-5448-4c55-9ad1-a61427c15837"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.DBError 后台DB执行错误。
InternalError.SystemError 系统错误。出现这种错误时,请联系客服支持。
InvalidParameter 输入参数错误。
InvalidParameterValue.InvalidCharset 数据库字符集错误,当前只支持UTF8、LATIN1。
ResourceUnavailable.InvalidInstanceStatus 实例状态错误。