GetBruteForceBanConfig - 获取暴力破解防护配置--云安全中心-火山引擎

文档中心

立即注册

导航

云安全中心

GetBruteForceBanConfig - 获取暴力破解防护配置

最近更新时间：2025.05.30 11:21:37首次发布时间：2025.05.30 11:21:37

获取暴力破解防护配置

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetBruteForceBanConfig	要执行的操作，取值：GetBruteForceBanConfig。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
TopGroupID	String	否	bkLaM	根分组ID

返回参数

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

参数	类型	示例值	描述
Enable	Boolean	true	是否打开防护
TopGroupID	String	oMGay	根分组ID
AccountID	String	uKubJ	账户ID
AgentIDList	Array of String	[EhXwc EGNcF DpYbC]	指定主机ID
AllHost	Boolean	true	是否全部主机
BanScenes	Array of String	[vjAtt dvVcL zGEXy]	封禁场景 SSH(SSH登录)/RDP(RDP登录)
RuleList	Array of Object	--	规则列表
BanType	String	quqMl	封禁方式 security_group(安全组封禁)
CloudProviders	Array of String	[bLtAx kXOwa AojvC]	云厂商
LeafGroupIDs	Array of String	[LIpnc mivoS WacnG]	叶子分组ID列表
Operator	String	iBltt	操作用户

请求示例

GET /?Action=GetBruteForceBanConfig&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
X-Date: 20241120T080538Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "GetBruteForceBanConfig",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "AccountID": "nnDpu",
    "AgentIDList": [
      "KfFAd",
      "sQlve",
      "IiZau"
    ],
    "AllHost": false,
    "BanScenes": [
      "rNfOy",
      "cwfFw",
      "ynvLY"
    ],
    "BanType": "ffUCl",
    "CloudProviders": [
      "slQIN",
      "coRnz",
      "hDmvT"
    ],
    "Enable": true,
    "LeafGroupIDs": [
      "LsEtV",
      "zscDo",
      "zJqvi"
    ],
    "Operator": "uTezz",
    "RuleList": [
      {
        "BanSeconds": 19,
        "Enable": false,
        "LoginFailCountThreshold": 39,
        "LoginFailTimeThreshold": 41,
        "RuleType": "fOTnx"
      }
    ],
    "TopGroupID": "ELJCk"
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	OperationDenied	Operation is denied because the specified resource is in use.	不允许的操作
400	InvalidParameter	The specified parameter %s is invalid.	请求参数错误
400	MissingParameter	The required parameter %s is missing.	请求参数缺失
500	InternalError	The request has failed due to an unknown error.	服务器内部错误