全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询事件分组列表

最近更新时间:2025-07-15 10:36:01

调用 DescribeSysEventGroupList 接口,查询指定账号下的事件分组列表

1.接口描述

请求方式:GET

请求域名:monitor.api.ksyun.com

VPC内域名:monitor.internal.api.ksyun.com

接口调用频率限制为:3600次/分钟。


2.接口调试

荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。


3. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

名称

必选

类型

描述

Action

String

公共参数,本接口取值:DescribeSysEventGroupList

Version

String

公共参数,本接口取值:2021-01-01

Namespace

String

表示一类云产品,指定命名空间。

示例值:KEC

StartTime

Integer

起始时间。

Tips:请注意时间格式为Unix时间戳(毫秒),从1970年1月1日开始所经过的毫秒数。

示例值:1634140600000

EndTime

Integer

结束时间。

Tips:请注意时间格式为Unix时间戳(毫秒),从1970年1月1日开始所经过的毫秒数。

示例值:1634150600000

EventName

String

指定事件名称。

Tips:支持同时查询多个事件,最多可查询10个事件。

示例值: XidError,SXidError

InstanceId

Array of String

指定实例ID。

Tips:支持同时查询多个实例,最多可查询20个实例。

Order

Boolean

结果按照事件创建时间排序方式。

有效值:

  • 0:倒序

  • 1:正序

PageIndex

Integer

页号

默认值:1

示例值:1

PageSize

Integer

每页显示的数据行数

默认值: 10

最大值:100


4.输出参数

名称

类型

说明

requestId

String

请求的ID。

code

String

状态码。

message

String

返回描述信息

sysEventGroupList

Array of SysEventGroup

资源列表

totalCount

Int

告警历史个数


5. 示例

示例1:查询云主机事件分组

输入示例

${region} 可替换相应区域,详见:Region 参考

${公共参数} 可替换相应区域,详见:公共参数

curl -X GET 'https://monitor.${region}.api.ksyun.com?Action=DescribeSysEventGroupList&Version=2021-01-01&Namespace=KEC' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H ${公共参数}
输出示例

支持XML和JSON

JSON格式

{
    "requestId": "7106664e-bce9-4871-b5df-9cf6e25ce142",
    "code": "Success",
    "message": "Success",
    "sysEventGroupList": [
        {
            "instanceId": "XXXX-XXXX-XXXX-XXXX-XXXXXXXXXX",
            "groupId": "XXXX-e11b-438e-82af-XXXXXXXXXX",
            "producttype": 0,
            "eventName": "InstanceLiveMigrationStart",
            "status": "Start",
            "createdAt": 1748228314317,
            "updateAt": 1748228314358,
            "planAt": 0,
            "finishAt": 0,
            "deadline": 0
        },
        {
            "instanceId": "XXXX-XXXX-XXXX-XXXX-XXXXXXXXXX",
            "groupId": "XXXX-e11b-438e-82af-XXXXXXXXXX",
            "producttype": 0,
            "eventName": "InstanceLiveMigrationFinished",
            "status": "Finished",
            "createdAt": 1748228101242,
            "updateAt": 1748228303636,
            "planAt": 0,
            "finishAt": 0,
            "deadline": 0
        }
    ],
    "totalCount": 11
}

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈