API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

本接口(InitDBInstances)用于初始化云数据库实例,包括设置默认字符集、表名大小写敏感等。接口请求域名: mariadb.tencentcloudapi.com 。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:InitDBInstances。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 待初始化的实例ID列表,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
Params.N Array of DBParamValue 参数列表。本接口的可选值为:character_set_server(字符集,必传),lower_case_table_names(表名大小写敏感,必传,0 - 敏感;1-不敏感),innodb_page_size(innodb数据页,默认16K),sync_mode(同步模式:0 - 异步; 1 - 强同步;2 - 强同步可退化。默认为强同步)。

3. 输出参数

参数名称 类型 描述
FlowId Integer 异步任务ID,可通过 DescribeFlow 查询任务状态。
InstanceIds Array of String 透传入参。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 批量初始化云数据库实例

输入示例

POST / HTTP/1.1
Host: mariadb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InitDBInstances
<公共请求参数>

{
    "Params": [
        {
            "Value": "16384",
            "Param": "innodb_page_size"
        },
        {
            "Value": "1",
            "Param": "lower_case_table_names"
        },
        {
            "Value": "utf8",
            "Param": "character_set_server"
        }
    ],
    "InstanceIds": [
        "tdsql-avw0207d",
        "tdsql-fdpjf5zh"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "d94ef093-ff84-4851-b2e0-a5c5920d618e",
        "InstanceIds": [
            "tdsql-fdpjf5zh",
            "tdsql-avw0207d"
        ],
        "FlowId": 3340
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CamAuthFailed CAM鉴权请求失败。
InternalError.DbOperationFailed 查询数据库失败。
InternalError.InnerSystemError 内部系统错误。
InternalError.OperateDatabaseFailed 操作数据库失败。
InvalidParameter 参数错误。
InvalidParameter.GenericParameterError 参数合法性校验错误。
InvalidParameter.InstanceNotFound 未找到请求的实例。
InvalidParameterValue.IllegalInitParam 初始化数据库实例参数错误。
InvalidParameterValue.SyncModeNotAllowed 当前部署方式不允许设置此同步模式。
ResourceUnavailable.BadInstanceStatus 实例状态错误,不能初始化。
ResourceUnavailable.InstanceStatusAbnormal 数据库实例状态不正确,当前无法操作。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。
目录