云数据库 PostgreSQL 关闭实例公网地址-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（CloseDBExtranetAccess）用于关闭实例公网地址。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CloseDBExtranetAccess。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DBInstanceId	是	String	实例ID，形如postgres-6r233v55 示例值：postgres-apzvwncr
IsIpv6	否	Integer	是否关闭Ipv6外网，1：是，0：否示例值：0

3. 输出参数

参数名称	类型	描述
FlowId	Integer	异步任务流程ID 示例值：1234
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 关闭实例外网

关闭实例postgres-apzvwncr外网。

输入示例

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

{
    "DBInstanceId": "postgres-apzvwncr"
}

输出示例

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

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure.UnauthorizedOperation	鉴权失败。
FailedOperation.CamSigAndAuthError	鉴权失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.DatabaseAccessError	管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.FailedOperationError	操作失败，请稍后重试。
FailedOperation.FlowCreateError	创建流程失败，请稍后重试。如果持续不成功，请联系客服进行处理。
InternalError.DBError	后台DB执行错误。
InternalError.FlowError	流程创建失败。
InternalError.InternalHttpServerError	请求执行异常。
InternalError.SystemError	系统错误。出现这种错误时，请联系客服支持。
InvalidParameter	参数错误。
InvalidParameterValue.InstanceNotExist	当前实例不存在。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
InvalidParameterValue.ParameterHandleError	参数处理失败，请检参数值设置是否有效。
OperationDenied.CamDeniedError	当前操作被限制。
OperationDenied.InstanceAccessDeniedError	您没有权限操作当前资源。
OperationDenied.InstanceStatusDeniedError	实例状态限制当前操作。
OperationDenied.InstanceStatusLimitOpError	实例状态限制当前操作。
ResourceNotFound.InstanceNotFoundError	实例不存在。
ResourceUnavailable.InvalidInstanceStatus	实例状态错误。

关闭实例公网地址

本页目录：