调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	SetBruteForceBanConfig	要执行的操作，取值：SetBruteForceBanConfig。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
AccountID	String	否	account-id-001	账户ID
BanType	String	否	security_group	该字段已弃用封禁方式 security_group(安全组封禁)
BanTypeList	Array of String	否	["security_group"]	封禁方式 security_group(安全组封禁) client(客户端封禁)
CloudProviders	Array of String	否	["volc"]	云厂商列表，精确匹配；可选值 volc（火山引擎）、volc_edge（火山边缘云）、ali（阿里云）、tencent（腾讯云）、huawei（华为云）、aws（AWS）、ibm（IBM Cloud）、azure（Azure）、idc（云外主机）；不传时不按云厂商筛选
SingleHostname	String	否	host-001	AgentIDList 长度为1时，展示具体的主机名称
AllHost	Boolean	否	true	是否全部主机；不传时按 false 处理；true 时对当前账户下已开启防护的全部主机下发任务；false 时需通过 AgentIDList、LeafGroupIDs 或 TopGroupID 指定范围，未指定任何主机范围时返回参数错误
ManagerID	String	否	manager-id-001	ManagerID 标识值，可从对应资源列表接口获取
Operator	String	否	admin@example.com	操作用户
SingleGroupPath	String	否	/production/web	LeafGroupIDList 长度为1时，展示具体的分组名称
BanScenes	Array of String	否	["SSH"]	封禁场景 SSH(SSH登录)/RDP(RDP登录)
Enable	Boolean	否	true	是否打开防护
LeafGroupIDs	Array of String	否	["group-id-101","group-id-102"]	叶子分组 ID 列表，可通过多级分组查询接口获取；不传时不限制叶子分组
RuleList	Array of Object	否	--	规则列表
TopGroupID	String	否	group-id-001	根分组 ID，可通过多级分组查询接口获取；不传时不限制根分组
AgentIDList	Array of String	否	["agent-id-001"]	指定主机ID列表；不传时不按主机 ID 限定
ID	String	否	resource-id-001	ID 标识值，可从对应资源列表接口获取

返回参数

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

参数	类型	示例值	描述
Data	String	success	返回结果

请求示例

POST /?Action=SetBruteForceBanConfig&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

{
  "AccountID": "account-id-001",
  "AgentIDList": [
    "agent-id-001"
  ],
  "AllHost": true,
  "BanScenes": [
    "SSH"
  ],
  "BanType": "security_group",
  "BanTypeList": [
    "security_group"
  ],
  "CloudProviders": [
    "volc"
  ],
  "Enable": true,
  "ID": "resource-id-001",
  "LeafGroupIDs": [
    "group-id-101",
    "group-id-102"
  ],
  "ManagerID": "manager-id-001",
  "Operator": "admin@example.com",
  "RuleList": [
    {
      "BanSeconds": 21600,
      "Enable": true,
      "LoginFailCountThreshold": 20,
      "LoginFailTimeThreshold": 600,
      "RuleType": "system"
    }
  ],
  "SingleGroupPath": "/production/web",
  "SingleHostname": "host-001",
  "TopGroupID": "group-id-001"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "SetBruteForceBanConfig",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": "success"
  }
}

错误码

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

状态码	错误码	错误信息	说明
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:20

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码