1. 接口描述
接口请求域名: mariadb.tencentcloudapi.com 。
创建MariaDB按量计费实例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateHourDBInstance。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Zones.N | 是 | Array of String | 节点可用区分布,可填写多个可用区。 示例值:["ap-guangzhou-1"] |
NodeCount | 是 | Integer | 节点个数 示例值:2 |
Memory | 是 | Integer | 内存大小,单位:GB 示例值:2 |
Storage | 是 | Integer | 储存大小,单位:GB 示例值:10 |
Count | 否 | Integer | 购买实例数量 示例值:1 |
ProjectId | 否 | Integer | 项目ID,不传表示默认项目 示例值:0 |
VpcId | 否 | String | 统一网络ID,不传表示基础网络 示例值:vpc-n2vdqxdx |
SubnetId | 否 | String | 统一子网ID,VpcId有值时需填写 示例值:subnet-j2ezrypg |
DbVersionId | 否 | String | 数据库引擎版本,当前可选:8.0,5.7,10.1,10.0。 示例值:5.7 |
InstanceName | 否 | String | 自定义实例名称 示例值:实例名称 |
SecurityGroupIds.N | 否 | Array of String | 安全组ID,不传表示不绑定安全组 示例值:["sg-123456"] |
Ipv6Flag | 否 | Integer | 是否支持IPv6,0:不支持,1:支持 示例值:0 |
ResourceTags.N | 否 | Array of ResourceTag | 标签键值对数组 |
DcnRegion | 否 | String | DCN源地域 示例值:ap-guangzhou |
DcnInstanceId | 否 | String | DCN源实例ID 示例值:tdsql-123456 |
InitParams.N | 否 | Array of DBParamValue | 参数列表。本接口的可选值为: character_set_server(字符集,必传),lower_case_table_names(表名大小写敏感,必传,0 - 敏感;1-不敏感), innodb_page_size(innodb数据页,默认16K),sync_mode(同步模式:0 - 异步; 1 - 强同步;2 - 强同步可退化,默认为强同步可退化)。 |
RollbackInstanceId | 否 | String | 回档源实例ID,例如“2021-11-22 00:00:00” 示例值:tdsql-dup8gl6t |
RollbackTime | 否 | String | 回档时间 示例值:2021-11-22 00:00:00 |
DcnSyncMode | 否 | Integer | DCN同步模式,0:异步, 1:强同步 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealName | String | 订单号。可以据此调用 DescribeOrders 查询订单详细信息,或在支付失败时调用用户账号相关接口进行支付。 示例值:20200409111543 |
InstanceIds | Array of String | 订单对应的实例 ID 列表,如果此处没有返回实例 ID,可以通过订单查询接口获取。还可通过实例查询接口查询实例是否创建完成。 注意:此字段可能返回 null,表示取不到有效值。 示例值:["tdsql-dup8gl6t"] |
FlowId | Integer | 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。 注意:此字段可能返回 null,表示取不到有效值。 示例值:22051110000 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建MariaDB按量计费实例
创建MariaDB按量计费实例
输入示例
POST / HTTP/1.1
Host: mariadb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHourDBInstance
<公共请求参数>
{
"DbVersionId": "5.7.17",
"VpcId": "vpc-n2vdqxdx",
"Storage": "10",
"Zones": [
"ap-guangzhou-1",
"ap-guangzhou-1"
],
"SubnetId": "subnet-j2ezrypg",
"Memory": "2",
"NodeCount": "2"
}
输出示例
{
"Response": {
"DealName": "20200409111543",
"InstanceIds": [
"tdsql-dup8gl6t"
],
"FlowId": 22051110000,
"RequestId": "05ad9b30-ac0a-4945-afd5-3d405d537a93"
}
}
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.CreateOrderFailed | 创建订单失败。 |
FailedOperation.TagDryRunError | 标签键值校验或鉴权失败。 |
FailedOperation.UserNotAuthed | 用户未经鉴权。 |
InternalError.CamAuthFailed | CAM鉴权请求失败。 |
InternalError.CheckVipStatusFailed | 检测vip状态失败。 |
InternalError.GetSubnetFailed | 查询虚拟私有网络子网信息失败。 |
InternalError.GetVpcFailed | 查询虚拟私有网络信息失败。 |
InternalError.InnerSystemError | 内部系统错误。 |
InternalError.OperateDatabaseFailed | 操作数据库失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.CheckParamNotPass | 入参校验失败。 |
InvalidParameter.GenericParameterError | 参数合法性校验错误。 |
InvalidParameter.InstanceNotFound | 未找到请求的实例。 |
InvalidParameter.SubnetNotFound | 找不到指定的虚拟私有网络子网。 |
InvalidParameter.VpcNotFound | 找不到指定的虚拟私有网络。 |
InvalidParameterValue.IllegalQuantity | 商品数量超出限制。 |
InvalidParameterValue.IllegalZone | 未找到对应的可用区信息。 |
InvalidParameterValue.SpecIdIllegal | 找不到数据库实例对应的规格信息。 |
ResourceUnavailable.InstanceStatusAbnormal | 数据库实例状态不正确,当前无法操作。 |
UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |
UnsupportedOperation.DbVersionNotSupported | 不支持该数据库版本。 |