1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
修改或解除已有入侵防御隔离记录,不用于新增隔离。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyIsolateTable。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| ButtonAction | 是 | String | 操作动作,仅接受精确值 edit 或 delete。ButtonAction 为 edit 时修改该资产所有匹配隔离记录的有效期,需传 StartTime 和 EndTime;ButtonAction 为 delete 时解除该资产的全部匹配隔离,StartTime 和 EndTime 可省略。 示例值:edit |
| InstanceID | 是 | String | 必填的资产实例 ID。调用 DescribeCfwRules,传 RuleType=intrusion_prevention、ListType=isolate 和目标 InstanceId,并使用完全匹配的 rules[].instance_id。edit 或 delete 作用于该实例的全部隔离记录。 示例值:instance-id-from-DescribeCfwRules |
| CfwAiAgentOperationSource | 否 | String | AI操作来源 枚举值:
示例值:console |
| EndTime | 否 | String | 隔离结束时间。ButtonAction 为 edit 时必填,格式为 YYYY-MM-DD HH:MM:SS,且不得早于 StartTime;除永久隔离值 3000-01-01 00:00:00 外,必须晚于当前时间。ButtonAction 为 delete 时可省略。 示例值:3000-01-01 00:00:00 |
| StartTime | 否 | String | 隔离起始时间。ButtonAction 为 edit 时必填,格式为 YYYY-MM-DD HH:MM:SS,且不得晚于 EndTime;该时间将应用于该实例的全部匹配隔离记录。ButtonAction 为 delete 时可省略。 示例值:2099-01-01 00:00:00 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReturnCode | Integer | 处理返回码:0 表示成功。 示例值:0 |
| ReturnMsg | String | 处理结果信息,成功时为 success。 示例值:success |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 编辑隔离有效期
使用 DescribeCfwRules(RuleType=intrusion_prevention、ListType=isolate、InstanceId)返回的 rules[].instance_id 编辑隔离有效期。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyIsolateTable
{
"InstanceID": "ins-doc-isolate-001",
"ButtonAction": "edit",
"StartTime": "2025-01-01 00:00:00",
"EndTime": "3000-01-01 00:00:00"
}
输出示例
{
"Response": {
"ReturnCode": 0,
"ReturnMsg": "success",
"RequestId": "00000000-0000-4000-8000-000000000001"
}
}
示例2 解除隔离
使用 DescribeCfwRules(RuleType=intrusion_prevention、ListType=isolate、InstanceId)返回的 rules[].instance_id 解除隔离;delete 不传时间参数。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyIsolateTable
{
"InstanceID": "ins-doc-isolate-002",
"ButtonAction": "delete"
}
输出示例
{
"Response": {
"ReturnCode": 0,
"ReturnMsg": "success",
"RequestId": "00000000-0000-4000-8000-000000000002"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |