1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
DescribeBlockList 告警中心阻断资产视图列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeBlockList。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Offset | 是 | Integer | 偏移量 示例值:0 |
| Limit | 是 | Integer | 长度 示例值:10 |
| StatTimeSpan | 是 | Integer | 频率类型 示例值:1 |
| StartTime | 是 | String | 开始时间 示例值:2021-05-26 00:00:00 |
| EndTime | 是 | String | 结束时间 示例值:2021-05-28 00:00:00 |
| SearchValue | 否 | String | 查询条件 示例值:"SearchValue":{"InstanceId":"1", "AssetName": "v_tpq,1"}, |
| Order | 否 | String | 升序降序 示例值:desc |
| By | 否 | String | 排序字段 示例值:AvgCount |
| Direction | 否 | String | 方向 1 入 0出 示例值:1 |
| ByPass | 否 | String | 是否处置 1处置 0不是 示例值:1 |
| Source | 否 | String | 来源 示例值:1 |
| Country | 否 | String | 国家 1国内 示例值:1 |
| AssetId | 否 | String | 资产id 示例值:ins-888 |
| LogSource | 否 | String | 日志来源 move:vpc间防火墙 示例值:move |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of BlockInfo | 阻断记录集合 |
| TopData | Array of BlockInfo | 置顶阻断记录集合 |
| Total | Integer | 数量 示例值:10 |
| TopCount | Integer | 置顶数量 示例值:20 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeBlockList
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBlockList
<公共请求参数>
{
"Direction": "xx",
"ByPass": "xx",
"Source": "xx",
"AssetId": "xx",
"Country": "xx",
"SearchValue": "xx",
"Order": "xx",
"StatTimeSpan": 0,
"Limit": 0,
"StartTime": "xx",
"Offset": 0,
"EndTime": "xx",
"By": "xx"
}
输出示例
{
"Response": {
"Total": 80,
"Data": [
{
"WhiteTag": "xx",
"DstAssetId": "xx",
"Hide": 0,
"Zone": "xx",
"Isolate": 0,
"AssetName": "xx",
"Direction": 0,
"SrcVpc": "xx",
"MaxDate": "xx",
"LogSource": "xx",
"IsTop": 0,
"DstAssetName": "xx",
"SrcIP": "xx",
"ByPass": 0,
"Count": 0,
"AvgCount": 0.0,
"EdgeId": "xx",
"AssetId": "xx",
"Country": "xx",
"Ignore": 0,
"UniqueId": "xx",
"AppID": "xx",
"DstVpcName": "xx",
"SrcVpcName": "xx",
"Block": 0,
"DstVpc": "xx",
"DstIP": "xx",
"EdgeName": "xx",
"BlockSource": 0,
"DstPort": "xx",
"MinDate": "xx"
}
],
"TopCount": 0,
"TopData": [
{
"WhiteTag": "xx",
"DstAssetId": "xx",
"Hide": 0,
"Zone": "xx",
"Isolate": 0,
"AssetName": "xx",
"Direction": 0,
"SrcVpc": "xx",
"MaxDate": "xx",
"LogSource": "xx",
"IsTop": 0,
"DstAssetName": "xx",
"SrcIP": "xx",
"ByPass": 0,
"Count": 0,
"AvgCount": 0.0,
"EdgeId": "xx",
"AssetId": "xx",
"Country": "xx",
"Ignore": 0,
"UniqueId": "xx",
"AppID": "xx",
"DstVpcName": "xx",
"SrcVpcName": "xx",
"Block": 0,
"DstVpc": "xx",
"DstIP": "xx",
"EdgeName": "xx",
"BlockSource": 0,
"DstPort": "xx",
"MinDate": "xx"
}
],
"RequestId": "xx"
}
}
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 | 未知参数错误。 |