关闭外网访问

最近更新时间:2018-09-28 14:59:58

1. 接口描述

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

本接口(CloseDBExtranetAccess)用于关闭云数据库实例的外网访问。关闭外网访问后,外网地址将不可访问,查询实例列表接口将不返回对应实例的外网域名和端口信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CloseDBExtranetAccess
Version String 公共参数,本接口取值:2018-04-11
Region String 公共参数,详见产品支持的地域列表
InstanceId String 待关闭外网访问的实例ID。形如:dcdbt-ow728lmc,可以通过 DescribeDCDBInstances 查询实例详情获得。

3. 输出参数

参数名称 类型 描述
FlowId Integer 异步任务Id,可通过 DescribeFlow 查询任务状态。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 关闭云数据库实例的外网访问

输入示例

https://dcdb.tencentcloudapi.com/?Action=CloseDBExtranetAccess
&InstanceId=dcdbt-avw0207d
&<公共请求参数>

输出示例

{
  "Response": {
    "FlowId": 3024,
    "RequestId": "2d1e21a2-b29a-490a-8be0-b61287d92e28"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CreateFlowFailed 创建流程失败。
InternalError.CamAuthFailed CAM鉴权请求失败。
InvalidParameter.GenericParameterError 参数合法性校验错误。
ResourceNotFound.NoInstanceFound 找不到指定的数据库实例。
ResourceUnavailable.InstanceAlreadyDeleted 数据库实例已被删除。
ResourceUnavailable.InstanceStatusAbnormal 数据库实例状态不正确,当前无法操作。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。