GET /setting/scan_groups
此API返回扫描组的相关信息。
请求
格式
GET /setting/scan_groups/{id}
参数
|
参数 |
类型 |
可选 |
描述 |
|---|---|---|---|
|
|
字符串 |
是 |
您希望显示信息的扫描组ID。 如果请求中未指定此参数，响应将包含您公司创建的所有扫描组的信息。 |
示例
请求您公司所有扫描组的信息：
GET /setting/scan_groups
请求扫描组的信息
16beea3e-d011-4c0c-932c-8d8e53******
:
GET /setting/scan_groups/16beea3e-d011-4c0c-932c-8d8e53******
响应
格式
{
"data": [
{
"id": "字符串",
"type": "scan_group",
"attributes": {
"name": "字符串",
"description": "字符串",
"schedule": "字符串",
"created_at": "2024-01-04T15:07:59.329Z"
},
"relationships": {
"scans": {
"data": [
{
"id": "字符串",
"type": "scan"
}
]
}
},
"links": {
"self": "字符串"
}
}
],
"links": {
"self": "字符串",
"next": "字符串"
},
"meta": {
"total": 0,
"elapsed": 0
}
}
属性
此端点返回一个包含多个属性的对象，每个属性包含有关扫描组设置的信息。
|
属性 |
类型 |
描述 |
|---|---|---|
|
|
对象 |
包含扫描组相关信息的属性列表。 |
|
|
字符串 |
扫描组的ID。 |
|
|
字符串 |
该对象描述的类型实体。
可能取值：
|
|
|
字符串数组 |
提供扫描组信息。 |
|
|
字符串 |
扫描组的名称。 |
|
|
字符串 |
扫描组的描述。 |
|
|
字符串 |
分配给扫描组的扫描计划。 |
|
|
字符串 |
扫描组的创建时间和日期。 |
|
|
对象 |
相关实体的列表。 |
|
|
对象 |
属于该扫描组的扫描账户列表。 |
|
|
字符串数组 |
提供相关扫描账户信息的列表。 |
|
|
字符串 |
关联扫描账户的ID。 |
|
|
String |
关联实体的类型。
可能取值：
|
|
|
Array of Strings |
提供与本扫描组相关的链接。 |
|
|
String |
指向该特定扫描组信息的直接链接。 |
|
以下属性仅在请求公司所有扫描组信息时返回（请求中未指定
|
||
|
|
Array of Strings |
提供用于在页面间导航的链接。 |
|
|
String |
指向该特定扫描组信息的直接链接。 |
|
|
String |
指向请求返回的下一个扫描组信息的直接链接。 |
|
|
Array of Integers |
提供与请求返回信息相关的整体信息。 |
|
|
Integer |
该请求返回的结果总数。 |
|
|
整数 |
您已查看的结果数量，包括当前显示的结果。 |
示例：
请求获取您公司所有扫描组的信息：
{
"data": [
{
"id": "11e1623b-6d41-42e1-9c62-f8c682******",
"type": "scan_group",
"attributes": {
"name": "测试扫描",
"description": "演示日专用",
"schedule": "0 1 * * 1",
"created_at": "2023-09-27T09:12:56+00:00"
},
"relationships": {
"scans": {
"data": []
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups/11e1623b-6d41-42e1-9c62-f8c682******"
}
},
{
"id": "16beea3e-d011-4c0c-932c-8d8e53******",
"type": "scan_group",
"attributes": {
"name": "演示组",
"description": "",
"schedule": "0 17 * * 0",
"created_at": "2023-09-26T08:09:44+00:00"
},
"relationships": {
"scans": {
"data": [
{
"id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
"type": "scan"
},
{
"id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
"type": "scan"
},
{
"id": "3c807067-4097-43ac-82d7-4ee2ef******",
"type": "scan"
},
{
"id": "6d1422ac-9eea-45e2-992e-27a243******",
"type": "scan"
}
]
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups/16beea3e-d011-4c0c-932c-8d8e53******"
}
},
{
"...": "..."
}
],
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups?page_limit=500",
"next": null
},
"meta": {
"total": 7,
"elapsed": 7
}
}
请求获取扫描组
16beea3e-d011-4c0c-932c-8d8e53******
:
{
"data": {
"id": "16beea3e-d011-4c0c-932c-8d8e53******",
"type": "scan_group",
"attributes": {
"name": "演示组",
"description": "",
"schedule": "0 17 * * 0",
"created_at": "2023-09-26T08:09:44+00:00"
},
"relationships": {
"scans": {
"data": [
{
"id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
"type": "scan"
},
{
"id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
"type": "scan"
},
{
"id": "3c807067-4097-43ac-82d7-4ee2ef******",
"type": "scan"
},
{
"id": "6d1422ac-9eea-45e2-992e-27a243******",
"type": "scan"
}
]
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups/16beea3e-d011-4c0c-932c-8d8e53******"
}
}
}