调试

API Explorer

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

去调试

请求参数

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

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

返回参数

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

参数	类型	示例值	描述
Enable	Boolean	true	是否打开防护
TopGroupID	String	group-id-001	根分组 ID，可通过多级分组查询接口获取；不传时不限制根分组
SingleHostname	String	host-001	AgentIDList 长度为1时，展示具体的主机名称
AccountID	String	account-id-001	账户ID
AgentIDList	Array of String	["agent-id-001"]	指定主机ID
AllHost	Boolean	true	是否全部主机
BanScenes	Array of String	["SSH"]	封禁场景 SSH(SSH登录)/RDP(RDP登录)
RuleList	Array of Object	--	规则列表
ManagerID	String	manager-id-001	ManagerID 标识值，可从对应资源列表接口获取
BanType	String	security_group	该字段已弃用封禁方式 security_group(安全组封禁)
CloudProviders	Array of String	["volcengine"]	云厂商
LeafGroupIDs	Array of String	["group-id-101","group-id-102"]	叶子分组 ID 列表，可通过多级分组查询接口获取；不传时不限制叶子分组
BanTypeList	Array of String	["security_group"]	封禁方式 security_group(安全组封禁) client(客户端封禁)
Operator	String	admin@example.com	操作用户
SingleGroupPath	String	/production/web	LeafGroupIDList 长度为1时，展示具体的分组名称

请求示例

GET /?Action=GetBruteForceBanConfig&Version=2024-05-08&TopGroupID=-- 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": "account-id-001",
    "AgentIDList": [
      "agent-id-001"
    ],
    "AllHost": true,
    "BanScenes": [
      "SSH"
    ],
    "BanType": "security_group",
    "BanTypeList": [
      "security_group"
    ],
    "CloudProviders": [
      "volcengine"
    ],
    "Enable": true,
    "LeafGroupIDs": [
      "group-id-101",
      "group-id-102"
    ],
    "ManagerID": "manager-id-001",
    "Operator": "admin@example.com",
    "RuleList": [
      {
        "BanSeconds": 1,
        "Enable": true,
        "LoginFailCountThreshold": 1,
        "LoginFailTimeThreshold": 600,
        "RuleType": "system"
      }
    ],
    "SingleGroupPath": "/production/web",
    "SingleHostname": "host-001",
    "TopGroupID": "group-id-001"
  }
}

错误码

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

状态码	错误码	错误信息	说明
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.	不允许的操作，请检查当前资源是否被占用。
403	OperationDenied.TenantUnauthorized(%s)	The request has failed due to tenant not found(%s)	未授权的租户操作
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

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码