获取报告列表
该方法根据接收的参数返回预定报告的列表。
结果中仅显示由 GravityZone 生成请求所用API密钥的用户创建的报告。
服务
调用此方法需在API URL中填入
{服务}
名称。允许的服务包括:
-
computers(计算机)对应"计算机与虚拟机" -
virtualmachines(虚拟机)对应"虚拟机"
例如,调用
虚拟机
服务的请求URL为:
https://您的域名/api/v1.0/jsonrpc/reports/virtualmachines
参数
|
参数名 |
类型 |
可选性 |
说明 |
|---|---|---|---|
|
|
字符串 |
是 |
报告名称 |
|
|
数值 |
是 |
报告类型。可选类型包括:
|
|
|
数字 |
是 |
结果页编号。默认页码为
|
|
|
数字 |
是 |
单页显示的项目数量。上限为每页100项。默认值:每页30项。 |
返回值
此方法返回包含报告信息的对象。返回对象包含:
-
当前页- 当前显示的页码 -
总页数- 可用页面总数 -
每页条数- 每页返回的项目总数 -
项目列表- 报告列表。列表中每个条目包含以下字段:-
ID,报告的唯一标识符 -
名称,报告的名称 -
类型,报告类型,详见参数表 -
执行周期,报告运行的时间间隔。可选值包括:2-每小时,3-每日,4-每周或5-每月。请注意值1(即时报告)不属于有效选项。
-
-
总数- 条目总数
示例
请求 :
{
"params": {
"type": 2,
"page": 2,
"perPage": 4
},
"jsonrpc": "2.0",
"method": "getReportsList",
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
}
响应 :
{
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
"jsonrpc":"2.0",
"result": {
"page": 2,
"pagesCount": 11,
"perPage": 5,
"total": 54
"items": [
{
'id': '5638cdceb1a43d46137b23c6',
'name': '我的报告1',
'occurrence': 2,
'type': 2
},
{
'id': '5638d7f8b1a43d49137b23c9',
'name': '我的报告2',
'occurrence': 4,
'type': 2
},
{
'id': u'563b271bb1a43d21077b23c8',
'name': '我的报告3',
'occurrence': 4,
'type': 2
},
{
'id': '563a289eb1a43d2f617b23c6',
'name': '我的报告4',
'occurrence': 2,
'type': 2
}
]
}
}