查询自定义规则详情 - ListCustomRuleConfigDetail

功能介绍

查询自定义规则详情

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/custom/rule/config/detail

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。约束限制: 不涉及取值范围: 字符长度1-256位默认取值: 不涉及

表2 Query参数
参数	是否必选	参数类型	描述
rule_id	是	String	参数解释：规则ID 约束限制：必填取值范围：字符长度1-36位默认取值：不涉及

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。约束限制: 不涉及取值范围: 字符长度1-32768位默认取值: 不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
rule_id	String	参数解释：规则ID 取值范围：字符长度1-36位
hash_type	String	参数解释： hash类型取值范围： SHA-256：sha256sum MD5：md5sum SHA-1：sha1sum
auto_block	Integer	参数解释：是否自动阻断告警取值范围： 0：不自动阻断告警 1：自动阻断告警
is_all_host	Boolean	参数解释: 是否选择所有主机取值范围: true：是 false：否
rule_type	String	参数解释：规则类型取值范围： black_hash：黑hash
rule_values	Array of strings	参数解释：规则集列表取值范围: 1-1000个规则值
agent_ids	Array of strings	参数解释: agent列表取值范围: 字符长度1-64位

请求示例

无

响应示例

状态码：200

请求已成功

{
  "rule_id" : "1f5357ae-bbc1-453f-8397-71a860f38933",
  "rule_values" : [ "08a7baa28dd268f8a12bc1f6fd95869321fe51144c5bf3321a6f6305edcd5245" ],
  "hash_type" : "sha256",
  "auto_block" : 1,
  "rule_type" : "black_hash",
  "is_all_host" : true,
  "agent_ids" : [ "xxx" ]
}