关闭外网访问

最近更新时间:2024-03-12 01:39:35

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CloseDBExtranetAccess。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 待关闭外网访问的实例ID。形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
示例值:tdsql-avw0207d
Ipv6Flag Integer 是否IPv6,默认0

3. 输出参数

参数名称 类型 描述
FlowId Integer 异步任务ID,可通过 DescribeFlow 查询任务状态。
示例值:3324
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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