DescribeHoneyPotList
最近更新时间: 2025-10-20 17:06:06
1. 接口描述
接口请求域名： cfw.api3.fincloud.tencent.cn。
查询蜜罐服务列表
默认接口请求频率限制：20次/秒。
接口更新时间：2023-06-27 11:28:51。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeHoneyPotList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-09-04 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| Limit | 是 | 否 | Int64 | 单页数量 |
| Offset | 是 | 否 | Int64 | 页偏移量 |
| ProbeId | 否 | 否 | String | 探针Id |
| SearchValue | 否 | 否 | String | 搜索参数，json格式字符串，空则传"{}"，蜜罐服务：service_type，交互类型：interaction_type，地域：region，蜜罐Id：service_id，蜜罐名称：service_name，诱饵：bait，开关：switch，状态：status，模糊搜索：common |
| Sort | 是 | 否 | String | 排序参数，探针数量从小到大probe_count:asc，探针数量从大到小probe_count:desc，命中次数从小到大hit_times:asc，命中次数从大到小hit_times:desc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AreaLists | SelectInfo | 此参数对外不可见。 地域列表 |
| Data | HoneyPotInfo | 此参数对外不可见。 蜜罐服务列表数据 |
| ReturnCode | Int64 | 此参数对外不可见。 状态值，0：查询成功，非0：查询失败 |
| ReturnMsg | String | 此参数对外不可见。 状态信息，success：查询成功，fail：查询失败 |
| Total | Int64 | 此参数对外不可见。 查询结果总数，用于分页 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |