查询实体列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-sas:ListEntities |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| IncidentUuid |
string |
是 |
事件 ID。 |
85ea4241-798f-4684-a876-65d4f0c3**** |
| EntityType |
string |
否 |
实体类型。取值：
|
ip |
| EntityName |
string |
否 |
实体名称。 |
host1**** |
| EntityUuid |
string |
否 |
实体 UUID。 |
6c740667-80b2-476d-8924-2e706feb**** |
| MalwareType |
string |
否 |
恶意实体类型。 |
aliyun.siem.sas.alert_tag.miner_software |
| IsMalwareEntity |
string |
否 |
是否恶意实体。 取值：
|
1 |
| Tags |
string |
否 |
实体标签。格式为 JSON 数组字符串：
|
[{"tagKey1":"tagValue1"},{"tagKey2":"tagValue2"}] |
| CurrentPage |
integer |
是 |
列表当前页号， 大于等于 1。 |
1 |
| PageSize |
integer |
是 |
列表每页条数， 最大不超过 100。 |
10 |
| RoleType |
integer |
否 |
视图类型。
|
1 |
| RoleFor |
integer |
否 |
管理员切换成其他成员视角的用户 ID。 |
113091674488**** |
| RegionId |
string |
否 |
威胁分析的数据管理中心所在地。您需要根据资产所在地域，选择管理中心所在地。取值：
|
cn-hangzhou |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
PageResponse<List |
||
| Success |
boolean |
请求是否成功。取值：
|
true |
| Code |
integer |
请求状态码。 |
200 |
| Message |
string |
请求返回消息。 |
success |
| RequestId |
string |
请求 ID。 |
9AAA9ED9-78F4-5021-86DC-D51C7511**** |
| Data |
object |
请求返回值。 |
123456 |
| PageInfo |
object |
分页记录。 |
|
| CurrentPage |
integer |
列表当前页号。 |
1 |
| PageSize |
integer |
每页返回记录数。 |
10 |
| TotalCount |
integer |
记录总数。 |
100 |
| ResponseData |
array<object> |
详细数据。 |
|
|
object |
|||
| Id |
integer |
实体 ID。 |
123456789*** |
| GmtCreate |
string |
实体采集时间。 |
2021-01-06 16:37:29 |
| GmtModified |
string |
实体最后更新时间。 |
2021-01-06 16:37:29 |
| Aliuid |
integer |
阿里云账户 ID。 |
123456789**** |
| IncidentUuid |
string |
事件 UUID，可以基于事件列表接口获取。 |
85ea4241-798f-4684-a876-65d4f0c3**** |
| AlertUuid |
string |
告警 UUID。 |
sas_71e24437d2797ce8fc59692905a4**** |
| AlertNum |
integer |
实体关联告警数量。 |
1 |
| EventNum |
integer |
实体关联事件数量。 |
1 |
| CloudCode |
string |
实体来源云 code。 取值：
|
aliyun |
| EntityType |
string |
实体类型。取值：
|
ip |
| EntityName |
string |
实体名称。 |
123.123.123.123 |
| EntityInfo |
string |
实体展示信息 json 格式。 |
{"file_path": "c:/www/leixi.jsp","file_hash": "aa0ca926ad948cd820e0a3d9a18c****","host_uuid": "efed2cf7-0b77-45d9-a97b-d2cf246b****","malware_type": "${aliyun.siem.sas.alert_tag.webshell}","host_name": "launch-advisor-2023****"} |
| SubUserId |
integer |
实体关联账号 ID。 |
113091674488**** |
| EntityId |
string |
实体逻辑 ID。 |
12345**** |
| EntityUuid |
string |
实体 UUID。 |
8087b3e4aa6862852c100c8738cf**** |
| MalwareType |
string |
实体恶意类型。 |
aliyun.siem.sas.alert_tag.webshell |
| IsAsset |
string |
是否为资产。取值：
|
1 |
| IsMalware |
string |
是否恶意实体。 取值：
|
0 |
| Tags |
string |
实体标签。格式为 JSON 数组字符串：
|
[{"tagKey1":"tagValue1"},{"tagKey2":"tagValue2"}] |
示例
正常返回示例
JSON格式
{
"Success": true,
"Code": 200,
"Message": "success",
"RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****",
"Data": {
"PageInfo": {
"CurrentPage": 1,
"PageSize": 10,
"TotalCount": 100
},
"ResponseData": [
{
"Id": 0,
"GmtCreate": "2021-01-06 16:37:29",
"GmtModified": "2021-01-06 16:37:29",
"Aliuid": 0,
"IncidentUuid": "85ea4241-798f-4684-a876-65d4f0c3****",
"AlertUuid": "sas_71e24437d2797ce8fc59692905a4****",
"AlertNum": 1,
"EventNum": 1,
"CloudCode": "aliyun",
"EntityType": "ip",
"EntityName": "123.123.123.123",
"EntityInfo": "{\"file_path\": \"c:/www/leixi.jsp\",\"file_hash\": \"aa0ca926ad948cd820e0a3d9a18c****\",\"host_uuid\": \"efed2cf7-0b77-45d9-a97b-d2cf246b****\",\"malware_type\": \"${aliyun.siem.sas.alert_tag.webshell}\",\"host_name\": \"launch-advisor-2023****\"}",
"SubUserId": 0,
"EntityId": "12345****",
"EntityUuid": "8087b3e4aa6862852c100c8738cf****",
"MalwareType": "aliyun.siem.sas.alert_tag.webshell",
"IsAsset": "1",
"IsMalware": "0",
"Tags": "[{\"tagKey1\":\"tagValue1\"},{\"tagKey2\":\"tagValue2\"}]"
}
]
}
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | InternalError | The request processing has failed due to some unknown error. | 服务发生某些未知错误，请稍后再试 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。