安全基线相关接口

更新时间：2019-06-14

查询检查结果列表

描述

查询检查结果列表。

请求结构

GET /v{version}/hosteye/securityBaseline/overview?pageNo={pageNo}&pageSize={pageSize}&zone={zone}&itemName={itemName}&category={category}&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken
pageNo	int	否	Query	页号，默认为1
pageSize	int	否	Query	页大小，默认为10
zone	zone	否	Query	区域，为空表示global
itemName	String	否	Query	风险名称
category	String	否	Query	风险类别

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
status	TaskStatus	任务状态
totalCount	int	检查结果总数目
baselineList	list<ItemCheckResultModel>	检查结果列表

请求示例

GET /v2/hosteye/securityBaseline/overview?pageNo=1&pageSize=10&zone=global&itemName=test&category=test&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "baselineList": [
        {
            "itemId": 10  //风险id
            "itemName" : NAME, //风险名称 
            "itemCategory": {                //风险分类
                "system" : "windows|linux",  //操作系统
                "application" : "APP",       //应用
                "category" : "category",     //检测类别
                "item" : "item",             //检测项目
            },
            "assetNumber": 10 // 受影响虚机数量
            "itemLevel" : "low"|"middle"|"high" //风险等级
            "updateTime" :  time//更新时间 UTC时间，如2018-01-01T00:00:00Z
        }
    ]
    "status" :0|1,   //0 任务进行中 1 任务已完成 
    "totalCount": 11 //总条目数
}

查询风险详情

描述

查询指定检查项目的风险详情。

请求结构

GET /v{version}/hosteye/securityBaseline/item/{item_id}?zone={zone}&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken
itemId	int	是	URL参数	检查项目id
zone	zone	否	Query	区域，默认为global

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
itemName	String	风险名称
itemLevel	ItemLevel	风险等级
updateTime	String	更新时间，UTC时间格式
itemCategory	ItemCategoryDescModel	风险类别描述
solution	String	修复建议
assetList	list<AssertModel>	虚机列表

请求示例

GET /v2/hosteye/securityBaseline/item/11?zone=global&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "itemName" : NAME, //风险名称 
    "itemLevel" : "low"|"middle"|"high" //风险等级
    "updateTime" :  time//更新时间
    "itemCategory": {                //风险分类
        "system" : "windows|linux",  //操作系统
        "application" : "APP",       //应用
        "category" : "category",     //检测类别
        "item" : "item",             //检测项目
    },
    "solution": "solution", //修复建议
    "assetList": [
        {
            "uuid": "BCC_ID1",                 //虚机长id
            "region": "bj",                    //区域信息
            "instanceId": "instanceId",        //短id
            "name": "name",                    //name
            "vmStatus": "vmStatus",            //虚机状态
            "cpu": "cpu",                      //cpu
            "memory": "memory",                //memory
            "diskSize": "diskSize",            //diskSize
            "instanceType": "instanceType",    //instanceType
            "internalIp" : "10.130.xx.xx" ,    //内网ip
            "publicIp" :  "180.xx.xx.xx",      //外网ip ， 没有则返回空
        },
    ],  //受影响虚机列表
}

查询检查时间配置

描述

查询检查时间配置情况。

请求结构

GET /v{version}/hosteye/securityBaseline/checkTime?clientToken={clientToken} HTTP/1.1
 Host: bss.{region}.baidubce.com
 Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
checkDate	list	检查日期
checkTime	int	检查时间

请求示例

GET /v2/hosteye/securityBaseline/checkTime?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "checkDate" : [0,1,2,3] //检查日期 0~6 代表周日～周六
    "checkTime" :  5       //检查时间 0～23 代表0点～23点
}

设置检查时间

描述

设置检查时间。

请求结构

PUT /v{version}/hosteye/securityBaseline/checkTime?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

{
    "checkDate" : [0,1,2,3] //检查日期 0~6 代表周日～周六
    "checkTime" :  5       //检查时间 0～23 代表0点～23点
}

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken
checkDate	list	是	RequestBody	检查日期
checkTime	int	是	RequestBody	检查时间

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

无特殊返回参数。

请求示例

PUT /v2/hosteye/securityBaseline/checkTime?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
    "checkDate" : [0,1,2,3] //检查日期 0~6 代表周日～周六
    "checkTime" :  5       //检查时间 0～23 代表0点～23点
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

查询检查规则列表

描述

查询检查规则列表。

请求结构

GET /v{version}/hosteye/securityBaseline/ruleList?pageNo={pageNo}&pageSize={pageSize}&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken
pageNo	int	否	Query	页号，默认为1
pageSize	int	否	Query	页大小，默认为10

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
ruleList	list<RuleModel>	规则列表
totalCount	int	规则总数目

请求示例

GET /v2/hosteye/securityBaseline/ruleList?pageNo=1&pageSize=10&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS
{
    "ruleList": [
        {
            "ruleId" : 10,    //规则ID
            "ruleName" : NAME, //规则名称 
            "assetNumber": 10           //检查虚机数量
            "itemNumber": 10            //检查项目数量
            "checkDate" : [0,1,2,3] //检查日期 0~6 代表周日～周六
            "checkTime" :  5       //检查时间 0～23 代表0点～23点                        
            "isDefault" :  0 | 1       //0 非默认规则, 1 默认规则                 
        },      

    ]
    "totalCount": 11 //总条目数
}

查询所有检查项目列表

描述

查询所有检查项目列表。

请求结构

GET /v{version}/hosteye/securityBaseline/itemList?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
ruleName	String	规则名称
items	list<ItemsModel>	规则列表

请求示例

GET /v2/hosteye/securityBaseline/itemList?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "items" : [
        {
            "items": [
                {
                    "items": [
                        {
                            "items": [
                                {
                                    "items": null,
                                    "name": "计划任务文件权限"
                                    "itemsId": 1 //item id int
                                    "status": 0|1  //0 未选择该风险项 | 1 已选择该风险项
                                },
                                {
                                    "items": null,
                                    "name": "检查已安装的软件包"
                                    "itemsId": 2
                                    "status": 0|1  //0 未选择该风险项 | 1 已选择该风险项                                                
                                },
                                {
                                    "items": null,
                                    "name": "检查全局可写的suid、sgid文件"
                                    "itemsId": 3        
                                    "status": 0|1  //0 未选择该风险项 | 1 已选择该风险项

                                }
                            ],
                            "name": "文件检查"
                        },
                        {
                            "items": [],
                            "name": "XX检查"
                        }
                    ],
                    "name": "linux 系统检查"
                },
                {
                    "items": [],
                    "name": "Apache Tomcat"
                }
            ],
            "name": "linux"
        },
        {
          "items": [],
          "name": "windows"
        }
    ]
}

创建检查规则

描述

创建检查规则。

请求结构

POST /v{version}/hosteye/securityBaseline/rule?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

{
     "ruleName" : NAME, //规则名称 
     "checkItem" : [itemsId1, itemsId2, itemsId3] //风险id列表
     "assetList": [
         {
             "uuid": "BCC_ID1", //虚机长id
             "region": "bj",    //区域信息
         },
     ],  //规则包含虚机列表
}

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken
ruleName	String	是	RequestBody	规则名称
checkItem	list	是	RequestBody	检查项目id列表
assetList	list<AssertIdModel>	虚机id列表

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

无特殊返回参数。

请求示例

POST /v2/hosteye/securityBaseline/rule?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
     "ruleName" : NAME, //规则名称 
     "checkItem" : [itemsId1, itemsId2, itemsId3] //风险id列表
     "assetList": [
         {
             "uuid": "BCC_ID1", //虚机长id
             "region": "bj",    //区域信息
         },
     ],  //规则包含虚机列表
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

查询检查规则

描述

查询指定规则id的检查规则配置。

请求结构

GET /v{version}/hosteye/securityBaseline/rule/{rule_id}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken
rule_id	int	是	Query	规则id

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
ruleName	String	规则名称
checkItem	list<ItemConfigModel>	规则列表
assetList	list<AssertModel>	虚机列表

请求示例

GET /v2/hosteye/securityBaseline/rule/1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "ruleName" : NAME,
    "checkItem" : [
        {
            "items": [
                {
                    "items": [
                        {
                            "items": [
                                {
                                    "items": null,
                                    "name": "计划任务文件权限"
                                    "itemsId": 1 //item id int
                                    "status": 0|1  //0 未选择该风险项 | 1 已选择该风险项
                                },
                                {
                                    "items": null,
                                    "name": "检查已安装的软件包"
                                    "itemsId": 2
                                    "status": 0|1  //0 未选择该风险项 | 1 已选择该风险项                                                
                                },
                                {
                                    "items": null,
                                    "name": "检查全局可写的suid、sgid文件"
                                    "itemsId": 3        
                                    "status": 0|1  //0 未选择该风险项 | 1 已选择该风险项

                                }
                            ],
                            "name": "文件检查"
                        },
                        {
                            "items": [],
                            "name": "XX检查"
                        }
                    ],
                    "name": "linux 系统检查"
                },
                {
                    "items": [],
                    "name": "Apache Tomcat"
                }
            ],
            "name": "linux"
        },
        {
          "items": [],
          "name": "windows"
        }
    ]
    "assetList": [             //用户所有虚机列表
        {
            "uuid": "BCC_ID1",                 //虚机长id
            "region": "bj",                    //区域信息
            "status": 0|1|2,                   //0 不属于任何规则 1 属于本规则 2 属于其他规则
            "instanceId": "instanceId",        //短id
            "name": "name",                    //name
            "vmStatus": "vmStatus",            //虚机状态
            "cpu": "cpu",                      //cpu
            "memory": "memory",                //memory
            "diskSize": "diskSize",            //diskSize
            "instanceType": "instanceType",    //instanceType  
            "internalIp" : "10.130.xx.xx" ,    //内网ip
            "publicIp" :  "180.xx.xx.xx",      //外网ip ， 没有则返回空                      
        },
    ],  //检查虚机列表
}

更新检查规则

描述

更新指定规则id的检查规则配置。

请求结构

PUT /v{version}/hosteye/securityBaseline/rule/{rule_id}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

{
     "ruleName" : NAME, //规则名称 
     "checkItem" : [itemsId1, itemsId2, itemsId3] //风险id列表
     "assetList": [
         {
             "uuid": "BCC_ID1", //虚机长id
             "region": "bj",    //区域信息
         },
     ],  //规则包含虚机列表
}

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken
rule_id	int	是	URL参数	规则id
ruleName	String	是	RequestBody	规则名称
checkItem	list	是	RequestBody	检查项目id列表
assetList	list<AssertIdModel>	虚机id列表

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

无特殊返回参数。

请求示例

PUT /v2/hosteye/securityBaseline/rule/1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
     "ruleName" : NAME, //规则名称 
     "checkItem" : [itemsId1, itemsId2, itemsId3] //风险id列表
     "assetList": [
         {
             "uuid": "BCC_ID1", //虚机长id
             "region": "bj",    //区域信息
         },
     ],  //规则包含虚机列表
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

删除检查规则

描述

删除指定规则id的检查规则。

请求结构

DELETE /v{version}/hosteye/securityBaseline/rule/{rule_id}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken
rule_id	int	是	URL参数	规则id

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

无特殊返回参数。

请求示例

DELETE /v2/hosteye/securityBaseline/rule/1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

立即检查

描述

立即检查，执行所有检查任务。

请求结构

PUT /v{version}/hosteye/securityBaseline/task?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值2
clientToken	String	是	Query参数	幂等性Token，详见clientToken

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域。

返回参数

无特殊返回参数。

请求示例

PUT /v2/hosteye/securityBaseline/task?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

网站后门相关接口

附录1

百度智能云

主机安全 HOSTEYE

主机安全 HOSTEYE

安全基线相关接口

查询检查结果列表

查询风险详情

查询检查时间配置

设置检查时间

查询检查规则列表

查询所有检查项目列表

创建检查规则

查询检查规则

更新检查规则

删除检查规则

立即检查