开通serverlessDB实例外网

最近更新时间:2020-03-23 08:11:27

1. 接口描述

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

开通serverlessDB实例外网

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:OpenServerlessDBExtranetAccess。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DBInstanceId String 实例的唯一标识符
DBInstanceName String 实例名称

3. 输出参数

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

4. 示例

示例1 根据实例ID开通serverless实例外网

输入示例

https://postgres.tencentcloudapi.com/?Action=OpenServerlessDBExtranetAccess
&DBInstanceId=postgres-apzvwncr
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
  }
}

示例2 根据实例名开通serverless实例外网

输入示例

https://postgres.tencentcloudapi.com/?Action=OpenServerlessDBExtranetAccess
&DBInstanceName=db-test
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AccountNotExist 当前账号不存在。
DBError 后台DB执行错误。
FailedOperation.QueryVpcFalied 获取VPC详情失败。
FlowError 流程创建失败。
InstanceNotExist 当前实例不存在。
InterfaceNameNotFound ACTION输入错误。
InternalError 内部错误。出现这种错误时,请联系客服支持。
InternalError.DBError 后台DB执行错误。
InternalError.FlowError 流程创建失败。
InternalError.SystemError 系统错误。出现这种错误时,请联系客服支持。
InternalError.UnknownError 其他未知错误。出现这种错误时,请联系客服支持。
InternalError.VpcError VPC相关错误。
InvalidAccountStatus 当前账号状态不正确,不允许操作。
InvalidInstanceStatus 实例状态错误。
InvalidParameter 输入参数错误。
InvalidParameterValue.IllegalRegion 非法的Region参数。
InvalidParameterValue.InstanceNotExist 当前实例不存在。
InvalidParameterValue.InterfaceNameNotFound ACTION输入错误。
InvalidParameterValue.StructParseFailed 解析参数出错。
ResourceUnavailable.InvalidInstanceStatus 实例状态错误。
ResourceUnavailable.ResourceNoPermission 没有该VPC网络权限。
ResourceUnavailable.VpcResourceNotFound 没有找到实例所属VPC信息。
StructParseFailed 解析参数出错。
SystemError 系统错误。出现这种错误时,请联系客服支持。
UnknownError 其他未知错误。出现这种错误时,请联系客服支持。
VpcError VPC相关错误。
目录