DescribeOperationEvents--消息队列 RabbitMQ版-火山引擎

文档中心

立即注册

导航

DescribeOperationEvents

最近更新时间：2024.02.23 15:26:18首次发布时间：2021.08.30 16:33:47

调用 DescribeOperationEvents 接口查询后台任务列表。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

请求参数

参数	参数类型	是否必选	示例值	说明
PageNumber	Integer	必选	1	后台任务列表的页码。
PageSize	Integer	必选	10	后台任务列表中每一页的条目数量。
Filters	List	必选		后台任务列表的筛选条件。需要指定： Key：筛选项。支持设置为： Source。其 Value 可设置为 OpenAPI 或 WebConsole。 Type。其 Value 可设置为 ModifyPlugin（插件变更）、ScaleInstance：（变更配置）或 RebootInstance（实例重启）。 Value：筛选项的值。
StartTime	Integer	可选	1645523741	后台任务的开始时间，Unix 时间戳格式。说明通过时间范围筛选后台任务列表时，需要同时指定 StartTime 和 EndTime，且 StartTime 应早于 EndTime。
EndTime	Integer	可选	1645523742	后台任务的结束时间，Unix 时间戳格式。说明通过时间范围筛选后台任务列表时，需要同时指定 StartTime 和 EndTime，且 StartTime 应早于 EndTime。
InstanceId	String	可选	rbtmq-*******	实例 ID。

响应参数

参数	参数类型	说明
OperationEvents	JSON Array	后台任务列表。详细信息请参考OperationEvent。
Total	Integer	总数。

示例

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=DescribeOperationEvents&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rabbitmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rabbitmq/request, SignedHeaders=x-date, Signature=********

{
  "PageNumber": 0,
  "PageSize": 10,
  "Filters": [
    {
      "Key": "Name",
      "Value": ""
    }
  ],
  "StartTime": 1645523741,
  "EndTime": 1645523741,
  "InstanceId": "rbtmq-*******"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "********",
    "Action": "DescribeOperationEvents",
    "Version": "2018-01-01",
    "Service": "rabbitmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "OperationEvents": [
      {
        "OperationName": "ModifyPlugin",
        "EventSource": "OpenAPI",
        "StartTime": 1645523741,
        "Status": "Executing",
        "EndTime": 1645523741,
        "Duration": 10,
        "OperationDetail": "开启rabbitmq_web_mqtt",
        "InstanceId": "rbtmq-*******",
        "OperationType": "ModifyPlugin",
        "EventID": "1"
      }
    ],
    "Total": 1
  }
}