文档中心>云防火墙>API 文档>访问控制相关接口>启用停用VPC间规则或Nat边界规则

启用停用VPC间规则或Nat边界规则

最近更新时间:2024-10-30 15:47:40

我的收藏

1. 接口描述

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

启用停用VPC间规则或Nat边界规则
VPC间规则需指定EdgeId。Nat边界规则需指定地域Region与Direction。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyEWRuleStatus。
Version String 公共参数,本接口取值:2019-09-04。
Region String 公共参数,本接口不需要传递此参数。
EdgeId String vpc规则必填,边id
示例值:EdgeId
Status Integer 是否开关开启,0:未开启,1:开启
示例值:1
Direction Integer 规则方向,0:出站,1:入站,默认1
示例值:1
RuleSequence Integer 更改的规则当前执行顺序
示例值:3
RuleType String 规则类型,vpc:VPC间规则、nat:Nat边界规则
示例值:vpc

3. 输出参数

参数名称 类型 描述
ReturnCode Integer 状态值,0:修改成功,非0:修改失败
示例值:0
ReturnMsg String 状态信息,success:查询成功,fail:查询失败
示例值:success
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 启用停用VPC间规则或Nat边界规则

启用停用VPC间规则或Nat边界规则

输入示例

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

{
    "RuleSequence": 5,
    "Direction": 1,
    "Status": 1,
    "RuleType": "vpc",
    "EdgeId": "EdgeId"
}

输出示例

{
    "Response": {
        "ReturnMsg": "success",
        "ReturnCode": 0,
        "RequestId": "9a86c4e3-b926-4244-919b-aba9a7e82686"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
OperationDenied 操作被拒绝。