查询事件列表
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
gaussdb:instance:listScheduleEvents
list
-
-
-
-
URI
GET /v3/{project_id}/schedule-events
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 否 | String | 参数解释: 事件ID。
约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_id | 否 | String | 参数解释: 实例ID。该参数值可调用查询数据库实例列表 - QueryingDBInstances接口,通过表 instances中的“id”获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| status | 否 | String | 参数解释: 事件状态。 约束限制: 不涉及。 取值范围:
默认取值: 为空,表示查询全部状态。 |
| type | 否 | String | 参数解释: 事件类型。 约束限制: 不涉及。 取值范围: RESTART_NODE:重启实例节点。 默认取值: 为空,表示查询全部类型。 |
| level | 否 | String | 参数解释: 事件级别。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| sort_field | 否 | String | 参数解释: 排序字段。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| order | 否 | String | 参数解释: 排序顺序。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| offset | 否 | Integer | 参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
| limit | 否 | Integer | 参数解释: 查询记录数。 约束限制: 不涉及。 取值范围: 1~100 默认取值: 10 |
响应参数
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释: 事件总数。 取值范围: 不涉及。 |
| inquiring_count | Integer | 参数解释: 待授权的事件数。 取值范围: 不涉及。 |
| schedule_count | Integer | 参数解释: 待执行的事件数。 取值范围: 不涉及。 |
| executing_count | Integer | 参数解释: 正在执行的事件数。 取值范围: 不涉及。 |
| failed_count | Integer | 参数解释: 执行失败的事件数。 取值范围: 不涉及。 |
| events | Array of objects | 参数解释: 事件详情列表,详见表4。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 事件ID。 取值范围: 不涉及。 |
| instance_id | String | 参数解释: 实例ID。 取值范围: 不涉及。 |
| instance_name | String | 参数解释: 实例名称。 取值范围: 不涉及。 |
| db_type | String | 参数解释: 数据库类型。 取值范围: gaussdbv5:GaussDB数据库。 |
| created_time | String | 参数解释: 事件创建的时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 |
| update_time | String | 参数解释: 事件更新的时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 |
| type | String | 参数解释: 事件类型。 取值范围: RESTART_NODE:重启实例节点。 |
| impact | String | 参数解释: 事件对系统的影响。 取值范围: 不涉及。 |
| status | String | 参数解释: 事件状态。 取值范围:
|
| reason | String | 参数解释: 事件发生的原因。 取值范围: 不涉及。 |
| level | String | 参数解释: 事件的严重级别。 取值范围:
|
| execute_time | String | 参数解释: 事件执行的时间。 取值范围: 不涉及。 |
| latest_execution_time | String | 参数解释: 事件最近一次执行的时间。 取值范围: 不涉及。 |
| execution_time_window | Array of objects | 参数解释: 事件执行的时间窗,详见表5。 |
请求示例
查询事件列表。
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/schedule-events
{
"id": "67323a8c-75aa-4d81-941e-02621ccd4d07",
"instance_id": "6970e9cf7adc41a78e0f1f50215c9d3bin03",
"status": "inquiring",
"type": "RESTART_NODE",
"offset": 0,
"limit": 50,
"sort_field": "execution_time_window",
"order": "desc"
} 响应示例
{
"total_count": 1,
"inquiring_count": 1,
"schedule_count": 0,
"executing_count": 0,
"failed_count": 0,
"events": [
{
"id": "created_time",
"instance_id": "0c08894f1d8f44d2a1f392a3d50fe96ein14",
"instance_name": "TestInstance",
"db_type": "gaussdbv5",
"created_time": "2024-06-30T09:04:35+0800",
"update_time": "2024-06-30T09:04:35+0800",
"type": "RESTART_NODE",
"impact": "Instance Intermittent Disconnection",
"status": "inquiring",
"reason": "ECS_RESTART",
"level": "critical",
"execute_time": "",
"latest_execution_time": "",
"execution_time_window": [{
"planned_execution_day": "2026-02-14",
"start_time": "02:00",
"end_time": "06:00"
}]
}
]
} 状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。