有奖捉虫:云通信与企业服务文档专题,速来> HOT
文档中心 > 云数据库 MySQL > API 文档 > 实例相关接口 > 创建云数据库只读实例的独立VIP

1. 接口描述

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

本接口(CreateRoInstanceIp)用于创建云数据库只读实例的独立VIP。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateRoInstanceIp。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 只读实例ID,格式如:cdbro-3i70uj0k,与云数据库控制台页面中显示的只读实例ID相同。
示例值:cdbro-c1nl9rpv
UniqSubnetId String 子网描述符,例如:subnet-1typ0s7d。
示例值:subnet-1typ0s7d
UniqVpcId String vpc描述符,例如:vpc-a23yt67j,如果传了该字段则UniqSubnetId必传
示例值:vpc-a23yt67j

3. 输出参数

参数名称 类型 描述
RoVpcId Integer 只读实例的私有网络的ID。
示例值:511512
RoSubnetId Integer 只读实例的子网ID。
示例值:115839
RoVip String 只读实例的内网IP地址。
示例值:172.0.0.1
RoVport Integer 只读实例的内网端口号。
示例值:3306
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建云数据库只读实例的独立VIP

输入示例

https://cdb.tencentcloudapi.com/?Action=CreateRoInstanceIp
&InstanceId=cdbro-c1nl9rpv
&UniqSubnetId=subnet-1typ0s7d
&<公共请求参数>

输出示例

{
    "Response": {
        "RoVpcId": 511512,
        "RoSubnetId": 115839,
        "RoVip": "172.0.0.1",
        "RoVport": 3306,
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
CdbError 后端错误或者流程错误。
FailedOperation.CreateRoVipError 申请只读实例独立VIP失败。
FailedOperation.StatusConflict 任务状态冲突。
InternalError.CdbError 系统错误。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.DesError 系统内部错误。
InternalError.HttpError Http请求异常。
InternalError.InternalHttpServerError 请求执行异常。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
InvalidParameter.ResourceNotFound 未找到相关资源。
InvalidParameterValue.InvalidParameterValueError 参数值无效。
OperationDenied 操作被拒绝。
OperationDenied.ActionInProcess 实例正在执行其他任务。
OperationDenied.WrongStatus 后端任务状态非法。
ResourceNotFound.CdbInstanceNotFoundError 未找到数据库实例,请确认您的实例状态是否正常。