接口功能介绍
根据id查询基线策略详情
接口约束
此功能为收费功能。请您确认已经购买服务器安全卫士配额,并且开启防护。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启防护。
URI
GET /v1/sca/rule/query/detail/{scaRuleId}
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
scaRuleId | 是 | Integer | 策略id | 1 |
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
userid | 是 | String | 用户id | 3416ab34d51e43bd97bc32b23ffbb443 | |
accountid | 是 | String | 账户id | 9e471e00e1c6485192b4478c96a14254 | |
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
accessKey | 是 | String | 鉴权公钥(安全卫士系统提供) | 18ee9b6b63e411e8b4a7186590d96509 | |
contentMD5 | 是 | String | 参数MD5值。默认使用空字符("")计算 | 1B2M2Y8AsgTpgAmY7PhCfg== | |
requestDate | 是 | String | 请求时间 | Mon, 29 Aug 2022 00:59:26 UTC | |
hmac | 是 | String | 使用HMAC算法生成信息摘要。HMAC原始信息中需要的字段:使用HMAC加密是,需要密钥和待加密消息。 1.密钥使用接口方提供的secretKey,作为加密密钥。 2.待加密消息:contentMD5、requestDate 、servicePath;三个部分通过"\n"进行连接。连接顺序contentMD5\nrequestDate\nservicePath: | mTOyK30c+4Poit2857iXCb8N7Qc= | |
urlType | 否 | String | 请求地址类型。EOPAPI(默认),CTAPI,API | EOPAPI |
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
code | 是 | String | 返回码。取值范围: 0:成功。 -1:失败。 -3:用户未签署协议,安全卫士系统无法正常使用。 -4:鉴权错误。 -5:用户没有付费版配额,功能不可用。 | 0 | |
message | 是 | String | 返回信息 | 成功 | |
data | 是 | Object | 返回对象 | ScaRulesDto |
表ScaRulesDto
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
id | 是 | Integer | 策略id | 1 | |
name | 是 | String | 策略名称 | 测试 | |
checkfrequency | 是 | String | 检测频率 | 1 | |
checktime | 是 | String | 检测时间 | 00:00-06:00 | |
description | 是 | String | 策略描述 | ||
scarulesHostsDtoList | 是 | list | scarulesHostsDtoList | ||
scarulesScaDtoList | 是 | list | scarulesScaDtoList |
表scarulesHostsDtoList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
scaruleid | 是 | Integer | 策略id | 1 | |
agentguid | 是 | String | 策略相关机器agentGuid | E3F52992-6046-4FA4-A926-61E45B184720 |
表scarulesScaDtoList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
scaruleid | 是 | Integer | 策略id | 1 | |
scaid | 是 | Integer | 基线id | 1 |
请求示例
请求头header
{
"userid": "3416ab34d51e43bd97bc32b23ffbb443",
"accountid": "9e471e00e1c6485192b4478c96a14254",
"regionid": "100054c0416811e9a6690242ac110002",
"accessKey": "18ee9b6b63e411e8b4a7186590d96509",
"contentMD5": "1B2M2Y8AsgTpgAmY7PhCfg==",
"hmac": "mTOyK30c+4Poit2857iXCb8N7Qc=",
"requestDate": "Mon, 29 Aug 2022 00:59:26 UTC"
}
请求体body
{
"agentGuids":"E3F52992-6046-4FA4-A926-61E45B184720",
"checkfrequency":1,
"checktime":"00:00-06:00",
"name":"4",
"osType":null,
"scaId":0,
"scaIds":"1",
}
响应示例
{
"code": "0",
"message": "查询成功!",
"data": {
"id": 233,
"name": "44",
"checkfrequency": 2,
"checktime": "06:00-12:00",
"description": null,
"scaIds": null,
"scaId": 0,
"agentGuids": null,
"zoneId": 173,
"type": 0,
"adminId": 0,
"ctyunUserId": "3416ab34d51e43bd97bc32b23ffbb443",
"createtime": "2022-01-06T08:57:01.000+00:00",
"osType": null,
"scarulesHostsDtoList": [
{
"scaruleid": 233,
"agentguid": "E3F52992-6046-4FA4-A926-61E45B184720",
"createtime": "2022-02-25T08:12:28.000+00:00"
},
{
"scaruleid": 233,
"agentguid": "F5283205-CB2C-45E6-8629-9D5DB63D3AC3",
"createtime": "2022-02-25T08:12:28.000+00:00"
}
],
"scarulesScaDtoList": [
{
"scaruleid": 233,
"scaid": 1,
"createtime": "2022-02-25T08:12:28.000+00:00"
},
{
"scaruleid": 233,
"scaid": 2,
"createtime": "2022-02-25T08:12:28.000+00:00"
}
]
}
}
状态码
状态码 | 描述 |
200 | 表示请求成功。 |
错误码
请参考错误码说明。