调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListBanIPList	要执行的操作，取值：ListBanIPList。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
AgentID	String	否	agent-id-001	主机ID
BanTypeList	Array of String	否	["security_group"]	封禁列表 security_group(安全组封禁)
SortOrder	String	否	Desc	排序顺序 Asc 升序排列 Desc 降序排列
StatusList	Array of String	否	["ban"]	封禁状态 ban(已封禁)/unban(已解封)/ban_fail(封禁失败)/unban_fail(解封失败)/banning(封禁中)/unbanning(解封中)
Tags	Array of String	否	["production"]	主机标签
BanStartTimeStartUnix	Long	否	1786492800	封禁开始时间范围起点，秒级 Unix 时间戳；与 BanStartTimeEndUnix 同时传入时生效
IP	String	否	192.0.2.10	IP
PageSize	Long	是	10	每页记录数，取值范围为 1~1000
TopGroupID	String	否	group-id-001	根分组 ID，可通过多级分组查询接口获取；不传时不限制根分组
BanEndTimeStartUnix	Long	否	1786492800	封禁结束时间范围起点，秒级 Unix 时间戳；与 BanEndTimeEndUnix 同时传入时生效
BanIP	String	否	192.0.2.10	封禁IP
BanPort	Long	否	8080	目的端口号；命中已配置的封禁端口区间（区间下限 ≤ 端口 ≤ 上限）；服务端不校验端口号范围，按 TCP/UDP 端口处理
BanType	String	否	security_group	封禁方式 security_group(安全组封禁)
HostName	String	否	host-001	主机名称
SortBy	String	否	LastHeartbeatTime	排序字段。支持取值：ban_ip（被封 IP）、ban_start_time_unix（封禁开始时间）、ban_end_time_unix（封禁结束时间）、ban_type（封禁类型）、port_start（起始端口）、port_end（结束端口）、iptables_id（规则 ID）、security_group_id（安全组 ID）、insert_time（创建时间）、update_time（更新时间）、account_id（账号 ID）、region（地域）、_id。未指定时默认 ban_start_time_unix（封禁开始时间）倒序。
BanEndTimeEndUnix	Long	否	1786579199	封禁结束时间范围终点，秒级 Unix 时间戳；与 BanEndTimeStartUnix 同时传入时生效
BanStartTimeEndUnix	Long	否	1786579199	封禁开始时间范围终点，秒级 Unix 时间戳；与 BanStartTimeStartUnix 同时传入时生效
CloudProviders	Array of String	否	["volc"]	云厂商列表，精确匹配；可选值 volc（火山引擎）、volc_edge（火山边缘云）、ali（阿里云）、tencent（腾讯云）、huawei（华为云）、aws（AWS）、ibm（IBM Cloud）、azure（Azure）、idc（云外主机）；不传时不按云厂商筛选
LeafGroupIDs	Array of String	否	["group-id-101","group-id-102"]	叶子分组 ID 列表，可通过多级分组查询接口获取；不传时不限制叶子分组
PageNumber	Long	是	1	翻页页码，取值范围为 1 及以上

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Data	Array of Object	--	分页业务数据，具体元素结构见各接口响应声明
PageNumber	Long	1	当前页面
PageSize	Long	20	页面大小
TotalCount	Long	1	全部数据条数

请求示例

POST /?Action=ListBanIPList&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T080538Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "AgentID": "agent-id-001",
  "BanEndTimeEndUnix": 1786579199,
  "BanEndTimeStartUnix": 1786492800,
  "BanIP": "192.0.2.10",
  "BanPort": 8080,
  "BanStartTimeEndUnix": 1786579199,
  "BanStartTimeStartUnix": 1786492800,
  "BanType": "security_group",
  "BanTypeList": [
    "security_group"
  ],
  "CloudProviders": [
    "volc"
  ],
  "HostName": "host-001",
  "IP": "192.0.2.10",
  "LeafGroupIDs": [
    "group-id-101",
    "group-id-102"
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "StatusList": [
    "ban"
  ],
  "Tags": [
    "production"
  ],
  "TopGroupID": "group-id-001"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListBanIPList",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AccountID": "account-id-001",
        "AgentID": "agent-id-001",
        "BanEndTimeUnix": 1786579199,
        "BanIP": "192.0.2.10",
        "BanStartTimeUnix": 1786492800,
        "BanType": "security_group",
        "CloudProvider": "volcengine",
        "EcsInstance": {
          "AccessKey": "AKLTEXAMPLE001",
          "AccountID": "account-id-001",
          "Architecture": "amd64",
          "Cpu": 1,
          "CreatedAt": "2024-05-08T10:00:00Z",
          "ECSUpdateAt": "2024-05-08T10:00:00Z",
          "EipAddress": "192.0.2.10",
          "HostName": "host-001",
          "IPList": [
            "192.0.2.10"
          ],
          "InstanceName": "example-name",
          "Mem": 1,
          "OsName": "veLinux 1.0 64位",
          "OsType": "veLinux",
          "Platform": "Linux",
          "PlatformVersion": "1.0",
          "PrimaryIpAddress": "192.0.2.10",
          "Region": "cn-beijing",
          "SecurityEnhancementStrategy": "security-enhancement-strategy-sample",
          "Status": "RUNNING",
          "Visibility": "visibility-sample",
          "VpcId": "vpc-id-001",
          "VpcName": "example-name",
          "ZoneId": "cn-beijing-a"
        },
        "GroupID": "group-id-001",
        "ID": "resource-id-001",
        "IPtablesID": "iptables-id-001",
        "InsertTime": 1786492800,
        "Platform": "ubuntu",
        "PortEnd": 1,
        "PortStart": 1,
        "Reason": "example reason",
        "Region": "cn-beijing",
        "RelateAlarmInfo": {
          "AlarmHandleMethod": 0,
          "AlarmType": "hids",
          "CloudProvider": "volcengine",
          "RelatedAlarmID": "alarm-id-001"
        },
        "SecurityGroupID": "group-id-001",
        "Status": "success",
        "Tags": [
          "production"
        ],
        "TopGroupID": "group-id-001",
        "UpdateTime": 1786579199
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter	The required parameter %s is missing.	请求参数缺失，请检查参数是否已正确传入。
400	InvalidParameter	The specified parameter %s is invalid.	请求参数错误，请检查参数传递内容是否正确。
400	OperationDenied	Operation is denied because the specified resource is in use.	不允许的操作，请检查当前资源是否被占用。
500	InternalError	The request has failed due to an unknown error.	服务器内部错误，请稍后重试或联系技术支持。
500	DBOperateError	The request has failed because database return error: %s	数据库操作异常，请稍后重试或联系技术支持。

最近更新时间：2026.10.30 14:06:21

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码