链接复制成功！
查询数据库Agent列表
功能介绍
查询数据库Agent列表
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/{instance_id}/audit/agents
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
instance_id |
是 |
String |
实例ID。可在查询实例列表接口的ID字段获取。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
db_id |
是 |
String |
数据库ID,可在查询数据库列表接口ID字段获取。 |
|
offset |
否 |
String |
偏移量 |
|
limit |
否 |
String |
查询记录数 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agents |
Array of agents objects |
agent列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agent_id |
String |
agent ID |
|
agent_type |
String |
agent 类型 |
|
agent_os |
String |
agent OS |
|
agent_ip |
String |
agent安装节点IP |
|
mem_threshold |
Integer |
内存阈值 |
|
cpu_threshold |
Integer |
cpu阈值 |
|
status |
Integer |
agent状态 |
|
agent_nic |
String |
agent网卡 |
|
db_name |
String |
数据库名称 |
|
datacap_status |
Integer |
数据流量抓取状态 |
|
agent_url |
String |
agent安装地址 |
|
universal |
Boolean |
是否CCE场景 |
|
sha256 |
String |
sha256值 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Object |
错误信息返回体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
请求示例
/v2/{project_id}/{instance_id}/audit/agents响应示例
状态码： 200
成功
{
"agents" : [ {
"agent_id" : "X1miCo8BDdIO3rwSbhug",
"agent_type" : "DB",
"agent_os" : "LINUX64_X86",
"agent_ip" : "2407:c080:11f0:23b:59d5:7ddf:5650:447b",
"agent_nic" : "",
"cpu_threshold" : 80,
"mem_threshold" : 80,
"db_name" : "",
"status" : 1,
"datacap_status" : 1,
"agent_url" : "/opt/dbss_audit/audit_server/agent/",
"universal" : false,
"sha256" : "2619a4fc8ff3b3dda48c4347630bc8d7ece2e1f046eab7ac044e7d0df49886e3"
} ]
}状态码： 400
请求参数错误
{
"error" : {
"error_code" : "DBSS.XXXX",
"error_msg" : "XXX"
}
}状态码： 500
服务器内部错误
{
"error" : {
"error_code" : "DBSS.XXXX",
"error_msg" : "XXX"
}
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
|
400 |
请求参数错误 |
|
403 |
认证失败 |
|
500 |
服务器内部错误 |
错误码
请参见错误码。
