SetBruteForceBanConfig - 设置暴力破解防护配置--云安全中心-火山引擎

文档中心

云安全中心

请输入

HIDS_ALARM

SetBruteForceBanConfig - 设置暴力破解防护配置

设置暴力破解防护配置

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	SetBruteForceBanConfig	要执行的操作，取值：SetBruteForceBanConfig。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
RuleList	Array of Object	否	--	规则列表
BanTypeList	Array of String	否	[Beyyl XcXvY oQChZ]	封禁方式 security_group(安全组封禁) client(客户端封禁)
AgentIDList	Array of String	否	[xkjDb gOzgi RfZut]	指定主机ID
CloudProviders	Array of String	否	[HMtyP tAIlY eLmSJ]	云厂商
Enable	Boolean	否	true	是否打开防护
SingleGroupPath	String	否	xCrdF	LeafGroupIDList 长度为1时，展示具体的分组名称
BanType	String	否	zxNBs	该字段已弃用封禁方式 security_group(安全组封禁)
SingleHostname	String	否	VzlWF	AgentIDList 长度为1时，展示具体的主机名称
ID	String	否	CAqSp	ID
LeafGroupIDs	Array of String	否	[aWxMQ aPxsP hjEUX]	叶子分组ID列表
Operator	String	否	HQxFk	操作用户
TopGroupID	String	否	opbLG	根分组ID
AccountID	String	否	xOvwT	账户ID
AllHost	Boolean	否	true	是否全部主机
BanScenes	Array of String	否	[QruZY KzsuU gJXto]	封禁场景 SSH(SSH登录)/RDP(RDP登录)
ManagerID	String	否	zITHo	ManagerID

返回参数

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

参数	类型	示例值	描述
Data	String	xxxx	data

请求示例

POST /?Action=SetBruteForceBanConfig&Version=2024-05-08HTTP/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": "yRAxh",
  "AgentIDList": [
    "MbwQJ",
    "eooFG",
    "tYOum"
  ],
  "AllHost": true,
  "BanScenes": [
    "Jwlfk",
    "FALcP",
    "cLlFp"
  ],
  "BanType": "TlvOH",
  "BanTypeList": [
    "hHDrj",
    "YiVqi",
    "LHxXA"
  ],
  "CloudProviders": [
    "tISMe",
    "klHQw",
    "PjPgn"
  ],
  "Enable": true,
  "ID": "shWCe",
  "LeafGroupIDs": [
    "goNdP",
    "KuBTW",
    "DGdiY"
  ],
  "ManagerID": "cWwnM",
  "Operator": "FIjcw",
  "RuleList": [
    {
      "BanSeconds": 52,
      "Enable": false,
      "LoginFailCountThreshold": 1,
      "LoginFailTimeThreshold": 62,
      "RuleType": "XmVmu"
    }
  ],
  "SingleGroupPath": "SgUEq",
  "SingleHostname": "tBYDl",
  "TopGroupID": "SgnWV"
}

返回示例

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

错误码

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

状态码	错误码	错误信息	说明
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.	服务器内部错误

最近更新时间：2026.06.01 14:36:57

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码