1. 接口描述
接口请求域名: dbdc.tencentcloudapi.com 。
该接口(CreateDBCustomCluster)用于创建 DB Custom 集群。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateDBCustomCluster。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-29。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-nanjing, ap-shanghai 。 |
| ContainerNetwork | 是 | ContainerNetwork | 容器网络,在此集群的所有 POD 与此网络连通 |
| ClusterName | 否 | String | 集群名称 入参限制:最长128个字符,只能为中文,英文,下划线。 示例值:生产集群-001 |
| ApiServerNetwork | 否 | ApiServerNetwork | 集群的API Server的网络信息 入参限制:必须为此账号下拥有的网络地址,可以与容器网络保持一致。 |
| ClusterDescription | 否 | String | 集群描述 示例值:L500 |
| Tags.N | 否 | Array of Tag | 集群标签 |
| ClientToken | 否 | String | 客户端Token 示例值:a8800d2e-db3e-41bb-8e49-f71fd8314047 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 本次创建的集群ID 示例值:dbcc-1p6xo1xz |
| TaskId | Integer | 本次创建集群的任务ID 示例值:80 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建 DB Custom 集群
输入示例
POST / HTTP/1.1
Host: dbdc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBCustomCluster
<公共请求参数>
{
"ContainerNetwork": {
"VpcId": "vpc-evvog2gd",
"SubnetIds": [
"subnet-clk8il4i"
]
},
"ClusterName": "生产集群-001",
"ApiServerNetwork": {
"VpcId": "vpc-evvog2gd",
"SubnetId": "subnet-clk8il4i"
},
"ClusterDescription": "L500",
"Tags": [
{
"Key": "环境",
"Value": "生产"
}
],
"ClientToken": "a8800d2e-db3e-41bb-8e49-f71fd8314047"
}
输出示例
{
"Response": {
"ClusterId": "dbcc-1p6xo1xz",
"TaskId": 80,
"RequestId": "95a44313-4cd0-436f-a9c1-99b449896ce6"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
| FailedOperation | 操作失败。 |
| InvalidParameterValue | 参数取值错误。 |