查询当前连接到数据库审计的Agent列表信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-dbaudit:GetAgentList | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 数据库审计实例的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。接口的参数说明，请参见 DescribeRegions 。 注意 调用 DescribeRegions 接口查询 D100 实例支持的地域时，公共参数的 Version（API 版本）必须取值2018-03-20。 | cn-hangzhou |
| InstanceId | string | 是 | 审计的实例 ID。 您可以通过调用 DescribeInstances 接口获取实例 ID。接口的参数说明，请参见 DescribeInstances 。 注意 调用 DescribeInstances 接口查询 D100 实例列表时，公共参数的 Version（API 版本）必须取值2018-03-20。 | dbaudit-cn-78v1gc**** |
| AgentIp | string | 否 | Agent 所在服务器的私网 IP 地址。支持 IPv4、IPv6 两种协议类型。 | 192.168.XX.XX |
| AgentStatus | integer | 否 | Agent 运行状态。默认值为 0。取值：
| 1 |
| AgentOs | string | 否 | Agent 所在服务器的操作系统类型。支持 Windows、Linux、Ubuntu、CentOS 等主流操作系统。 | Windows |
| Lang | string | 否 | 请求和接收消息的语言类型。取值：
| zh |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "1B217656-2267-4FBF-B26C-CDD201BDC3B8",
"AgentList": [
{
"VpcId": "v-asd2rrddgs****",
"PrivateIp": "192.168.XX.XX",
"RmagentMem": 5,
"AgentId": "rmagent_2ze68o4fden9o1s****",
"RmagentCpu": 5,
"FirstLoginTime": "2020-09-29 11:05:22",
"AgentOs": "Windows",
"AgentStatus": 1,
"AgentPort": "49046",
"AgentVersion": "3.2.5.3-1",
"SendPackets": 100000,
"SendBytes": 100000,
"LastActiveTime": "2020-09-29 15:50:22",
"SendPacketCount": 1000000,
"EcsId": "i-2zel0147166****",
"PublicIp": "1",
"SendByteCount": 1000000,
"PktLoss": 5,
"OsCpu": 3,
"OsMem": 10,
"SysConfig": "4C8G",
"Tags": [
{
"TagId": 100,
"TagKey": "key",
"TagValue": "value"
}
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-16 | OpenAPI 返回结构发生变更 | 查看变更详情 |