查询防护服务器列表 - ListProtectionServers
功能介绍
查询防护服务器列表：查询防护服务器相关数据，包含服务器名称、ip地址、操作系统、服务器组名称、防护策略、防护状态、微服务防护状态、RASP防护状态、RASP攻击数量信息
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/rasp/servers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
offset |
是 |
Integer |
查询起始点 |
|
limit |
是 |
Integer |
每页显示个数 |
|
host_name |
否 |
String |
云主机名称 |
|
os_type |
否 |
String |
操作系统类型，包含如下2种。
|
|
host_ip |
否 |
String |
云主机私有IP |
|
app_type |
否 |
String |
应用类型，包含如下1种。
|
|
app_status |
是 |
String |
应用防护状态，包含如下2种。
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-auth-token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
总数 |
|
data_list |
Array of ProtectionServeInfo objects |
list |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
服务器ID |
|
agent_id |
String |
Agent ID |
|
agent_version |
String |
Agent版本 |
|
host_name |
String |
服务器名称 |
|
public_ip |
String |
弹性ip地址 |
|
private_ip |
String |
私有ip |
|
os_type |
String |
操作系统类型 |
|
rasp_status |
String |
应用防护状态 |- 应用防护状态，包含如下6种。
|
|
policy_name |
String |
防护策略名称 |
|
is_friendly_user |
Boolean |
是否为友好用户 |
|
agent_support_auto_attach |
Boolean |
agent是否支持动态加载 |
|
agent_status |
String |
Agent状态 |
|
auto_attach |
Boolean |
动态加载是否开启 |
|
protect_status |
String |
防护状态 |- agent防护状态，包含如下2种。
|
|
group_id |
String |
服务器组ID |
|
group_name |
String |
服务器组名称 |
|
protect_event_num |
Long |
防护事件数 |
|
rasp_port |
Integer |
RASP端口号 |
请求示例
无
响应示例
状态码：200
请求已成功
{
"total_num" : 9,
"data_list" : [ {
"host_id" : "d04e7903-0a66-4fde-93e7-*******",
"agent_id" : "06af36ee0874501a2***********bb908fb818a8fdf2e0af487457ebc22",
"agent_version" : "3.2.17",
"host_name" : "ecs-******-nacos-test",
"public_ip" : "",
"private_ip" : "192.168.0.**",
"os_type" : "Linux",
"group_id" : "d9327506-5282-3017-9077-******",
"protect_event_num" : 0,
"rasp_port" : 19999,
"auto_attach" : false,
"rasp_status" : "app_not_configure",
"protect_status" : "opened",
"policy_name" : "默认策略",
"agent_support_auto_attach" : true,
"is_friendly_user" : true
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
