GET /setting/scans
该API返回扫描账户信息。扫描账户包含与云账户相关的所有信息及设置。
请求
格式
GET /setting/scans/{id}
参数
|
参数 |
类型 |
可选 |
描述 |
|---|---|---|---|
|
|
字符串 |
是 |
您希望显示信息的扫描账户ID。 如果请求中未指定此参数，响应将包含您公司所有扫描账户的信息。 |
示例
请求您公司所有扫描账户的信息：
GET /setting/scans/
请求扫描账户信息
2eee770a-e63d-47b2-a9ff-676f3a******
:
GET /setting/scans/2eee770a-e63d-47b2-a9ff-676f3a******
响应
格式
{
"data": [
{
"id": "字符串",
"type": "scan",
"attributes": {
"name": "字符串",
"target": "字符串",
"is_enabled": true,
"is_archived": true,
"created_at": "2024-01-03T07:25:51.746Z"
},
"relationships": {
"scan_group": {
"data": {
"id": "字符串",
"type": "scan_group"
}
}
},
"links": {
"self": "字符串"
}
}
],
"links": {
"self": "字符串",
"next": "字符串"
},
"meta": {
"total": 0,
"elapsed": 0
}
}
属性
此端点返回一个包含多个属性的对象，每个属性均包含与云账户相关的信息。
|
属性 |
类型 |
描述 |
|---|---|---|
|
|
对象 |
包含扫描账户相关信息的属性列表。 |
|
|
字符串 |
扫描账户的ID。 |
|
|
字符串 |
对象所描述的实体类型。
可能取值：
|
|
|
Object |
提供扫描账户信息。 |
|
|
String |
扫描账户的名称。 |
|
|
String |
扫描账户所属云服务提供商的账户名称。 |
|
|
Boolean |
指示是否为此扫描账户启用扫描功能。 |
|
|
Boolean |
指示该扫描账户是否已被禁用。 |
|
|
String |
云账户上线的日期和时间。 |
|
|
Object |
相关实体的列表。 |
|
|
Object |
扫描账户所属的扫描组列表。 |
|
|
Array of Strings |
提供相关扫描组信息的列表。 |
|
|
字符串 |
相关扫描组的ID。 |
|
|
字符串 |
相关实体的类型。可能取值：
|
|
|
字符串数组 |
提供与本扫描账户相关的链接。 |
|
|
字符串 |
指向该特定扫描账户信息的直接链接。 |
|
以下属性仅在请求公司所有云账户信息时返回（请求中未指定
|
||
|
|
字符串数组 |
提供用于在页面间导航的链接。 |
|
|
字符串 |
指向该特定扫描账户信息的直接链接。 |
|
|
字符串 |
指向请求返回的下一个扫描账户信息的直接链接。 |
|
|
整数数组 |
提供关于请求返回信息的总体说明。 |
|
|
整数 |
请求返回的结果总数。 |
|
|
整数 |
已查看的结果数量（包括当前显示的结果）。 |
示例
请求获取某公司所有已上线的云账户信息：
{
"data": [
{
"id": "2eee770a-e63d-47b2-a9ff-676f3a******",
"type": "scan",
"attributes": {
"name": "cy-test-project-no-billing",
"target": "cy-test-project-no-billing",
"is_enabled": false,
"is_archived": true,
"created_at": "2023-10-04T04:57:10+00:00"
},
"relationships": {
"scan_group": {
"data": {
"id": "8d7d5bac-9cab-405f-9ec7-ed89c6******",
"type": "scan_group"
}
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scans/2eee770a-e63d-47b2-a9ff-676f3a******"
}
},
{
"id": "3c807067-4097-43ac-82d7-4ee2ef******",
"type": "scan",
"attributes": {
"name": "[Staging] ****** AWS Account",
"target": "arn:aws:iam::829960215233:role/*******-******-scanner-test-0-IAMRole*************-1IEYW8O750PXW",
"is_enabled": true,
"is_archived": false,
"created_at": "2023-09-26T09:22:18+00:00"
},
"relationships": {
"scan_group": {
"data": {
"id": "16beea3e-d011-4c0c-932c-8d8e532a794c",
"type": "scan_group"
}
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scans/3c807067-4097-43ac-82d7-4ee2ef******"
}
},
{
"...": "..."
}
],
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scans?page_limit=500",
"next": null
},
"meta": {
"total": 14,
"elapsed": 14
}
}
请求获取ID为
2eee770a-e63d-47b2-a9ff-676f3a******
的特定云扫描账户信息：
{
"data": {
"id": "2eee770a-e63d-47b2-a9ff-676f3a******",
"type": "scan",
"attributes": {
"name": "cy-test-project-no-billing",
"target": "cy-test-project-no-billing",
"is_enabled": false,
"is_archived": true,
"created_at": "2023-10-04T04:57:10+00:00"
},
"relationships": {
"scan_group": {
"data": {
"id": "8d7d5bac-9cab-405f-9ec7-ed89c6******",
"type": "scan_group"
}
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scans/2eee770a-e63d-47b2-a9ff-676f3a******"
}
}
}