告警中心-隔离处置接口

最近更新时间:2024-03-12 01:16:08

我的收藏

1. 接口描述

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

用户告警中心-封隔离处置按钮

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAlertCenterIsolate。
Version String 公共参数,本接口取值:2019-09-04。
Region String 公共参数,本接口不需要传递此参数。
HandleAssetList.N Array of String 处置对象,资产列表
示例值:["ins-fwynfguf"]
HandleTime Integer 处置时间
1 1天
7 7天
-2 永久
示例值:7
AlertDirection Integer 当前日志方向: 0 出向 1 入向
示例值:1
IsolateType.N Array of Integer 隔离类型
1 互联网入站
2 互联网出站
4 内网访问
示例值:[1,2,4]
OmMode Integer 运维模式 1 IP白名单 2 身份认证 0 非运维模式
示例值:0

3. 输出参数

参数名称 类型 描述
ReturnCode Integer 返回状态码:
0 成功
非0 失败
示例值:0
ReturnMsg String 返回信息:
success 成功
其他
示例值:success
Status Integer 处置状态码:
0 处置成功
-1 通用错误,不用处理
-3 表示重复,需重新刷新列表
其他
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 告警中心-隔离操作示例

告警中心-隔离操作示例

输入示例

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

{
    "HandleAssetList": [
        "ins-fwynfguf"
    ],
    "HandleTime": 7,
    "AlertDirection": 0,
    "IsolateType": [
        1,
        2,
        4
    ],
    "OmMode": 1
}

输出示例

{
    "Response": {
        "RequestId": "9ed67674-49b2-486b-985b-709f92508601",
        "ReturnCode": 0,
        "ReturnMsg": "success",
        "Status": 0
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码