# 获取事件列表 - ShowInstanceScheduleEvents #### 功能介绍 获取事件列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:event:listScheduleEvents | List | - | - | gaussdb:event:listScheduleEvents | - | #### URI GET /v3/{project_id}/schedule-events 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释**： 事件ID。 您可以登录管理控制台，在事件管理列表中查看事件ID。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，前面为UUID，后缀为ev07，长度为36个字符。 **默认取值**： 不涉及。 | | instance_id | 否 | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 获取方法请参见[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 **默认取值**： 不涉及。 | | status | 否 | String | **参数解释**： 事件状态。 **约束限制**： 不涉及。 **取值范围**： - inquiring：待授权。 - scheduled：待执行。 - executing：执行中。 - completed：执行完成。 - canceled：事件关闭。 - failed：执行失败。 **默认取值**： 不涉及。 | | type | 否 | String | **参数解释**： 事件类型。 **约束限制**： 不涉及。 **取值范围**： - system.lifecycle.rebuild_node：备机重建事件。 - system.lifecycle.db_upgrade：数据库内核小版本升级事件。 - system.scheduled_event.high_cpu_memory：实例CPU或内存高负载事件，需要变更实例规格。 **默认取值**： 不涉及。 | | level | 否 | String | **参数解释**： 事件级别。 **约束限制**： 不涉及。 **取值范围**： - critical：紧急。 - major：重要。 - minor：一般。 - info：提示。 **默认取值**： 不涉及。 | | sort_field | 否 | String | **参数解释**： 响应列表排序字段。 **约束限制**： 不涉及。 **取值范围**： - created_time：创建时间。 - updated_time：更新时间。 - execution_time_window：执行时间窗。 - execute_time： 执行时间。 **默认取值**： 不涉及。 | | order | 否 | String | **参数解释**： 响应列表根据sort_field字段的排序方式（升序/降序）。 **约束限制**： sort_field不为空时生效。 **取值范围**： - asc：升序排列。 - desc：降序排列。 **默认取值**： 不涉及。 | | limit | 否 | Integer | **参数解释**： 查询记录数。 **约束限制**： 必须为整数，不能为负数。 **取值范围**： 1-100。 **默认取值**： 10。 | | offset | 否 | Integer | **参数解释**： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制**： 必须为整数，不能为负数。 **取值范围**： ≥0 **默认取值**： 0。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释**： 事件总数。 **取值范围**： 不涉及。 | | inquiring_count | Integer | **参数解释**： 待授权的事件数。 **取值范围**： 不涉及。 | | schedule_count | Integer | **参数解释**： 待执行的事件数。 **取值范围**： 不涉及。 | | executing_count | Integer | **参数解释**： 正在执行的事件数。 **取值范围**： 不涉及。 | | failed_count | Integer | **参数解释**： 执行失败的事件数。 **取值范围**： 不涉及。 | | events | Array of [ScheduleEventInfo] objects | **参数解释**： 事件详情列表，包含事件ID、事件类别、事件状态、事件级别、实例信息、执行时间等详细信息 | 表5ScheduleEventInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 事件ID。 **取值范围**： 只能由英文字母、数字组成，前面为UUID，后缀为ev07，长度为36个字符。 | | category | String | **参数解释**： 事件类别。 **取值范围**： Maintenance：计划内运维事件。 | | impact | String | **参数解释**： 事件影响。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 事件状态。 **取值范围**： - inquiring：待授权。 - scheduled：待执行。 - executing：执行中。 - completed：执行完成。 - canceled：事件关闭。 - failed：执行失败。 | | reason | String | **参数解释**： 事件原因。 **取值范围**： 不涉及。 | | level | String | **参数解释**： 事件级别。 **取值范围**： - critical：紧急。 - major：重要。 - minor：一般。 - info：提示。 | | instance_id | String | **参数解释**： 实例ID。 **取值范围**： 只能由英文字母、数字组成，前面为UUID，后缀为in07，长度为36个字符。 | | instance_name | String | **参数解释**： 实例名称。 **取值范围**： 最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 | | db_type | String | **参数解释**： 引擎名称。 **取值范围**： taurus：TaurusDB企业版。 | | created_time | String | **参数解释**： 创建时间。UTC，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 **取值范围**： 不涉及。 | | updated_time | String | **参数解释**： 更新时间。UTC，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 事件类型。 **取值范围**： - system.lifecycle.rebuild_node：备机重建事件。 - system.lifecycle.db_upgrade：数据库内核小版本升级事件。 - system.scheduled_event.high_cpu_memory：实例CPU或内存高负载事件，需要变更实例规格。 | | extend_info | String | **参数解释**： 扩展信息。 **取值范围**： 不涉及。 | | execute_time | String | **参数解释**： 事件的执行时间。UTC，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 **取值范围**： 不涉及。 | | execution_time_window | [ExecuteWindow] object | **参数解释**： 事件执行窗口。 | | event_entities | Array of [EventEntity] objects | **参数解释**： 事件对象信息列表，包含事件对象ID和事件对象的执行状态 | 表6ExecuteWindow | 参数 | 参数类型 | 描述 | |:---|:---|:---| | planned_execution_day | String | **参数解释**： 计划执行日期，格式为："yyyy-MM-dd"。 **取值范围**： 不涉及。 | | start_time | String | **参数解释**： 事件执行窗口开始时间，格式为 "hh:mm"。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 事件执行窗口结束时间，格式为 "hh:mm"。 **取值范围**： 不涉及。 | 表7EventEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | event_entity_id | String | **参数解释**： 事件对象ID。 **取值范围**： 实例ID或者节点ID。只能由英文字母、数字组成，后缀为in07或no07，长度为36个字符。 | | event_entity_status | String | **参数解释**： 事件对象的执行状态。 **取值范围**： - inquiring：待授权。 - scheduled：待执行。 - executing：执行中。 - completed：执行完成。 - canceled：事件关闭。 - failed：执行失败。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 查询事件列表。 ``` GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/schedule-events?sort_field=created_time&limit=1&offset=0&status=completed&order=asc ``` #### 响应示例 **状态码：200** ``` { "events" : [ { "id" : "6d33540dff4b428abccf00114e071fbcev07", "category" : "Maintenance", "impact" : "The instance is temporarily interrupted during the rebuild.", "status" : "completed", "reason" : "The virtual machine has a container escape security risk. The TaurusDB instance needs to rebuild node.", "level" : "major", "instance_id" : "4d9386406bdd481da555e7c16b8e0599in07", "instance_name" : "Taurusdb-2c7a", "db_type" : "taurus", "created_time" : "2025-12-15T13:00:00Z", "updated_time" : "2025-12-16T13:08:25Z", "type" : "system.lifecycle.rebuild_node", "execute_time" : "2025-12-16T13:00:56Z", "execution_time_window" : { "planned_execution_day" : "2025-12-30", "start_time" : "01:00", "end_time" : "02:00" }, "event_entities" : [ { "event_entity_id" : "9b8c6f2c77d04327b131bc704e9cfc02no07", "event_entity_status" : "scheduled" }, { "event_entity_id" : "9b8c6f2c77d04327b131bc704e9cfc02no07", "event_entity_status" : "scheduled" } ] } ], "total_count" : 1, "inquiring_count" : 0, "schedule_count" : 0, "executing_count" : 0, "failed_count" : 0 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class ShowInstanceScheduleEventsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("")) .build(); ShowInstanceScheduleEventsRequest request = new ShowInstanceScheduleEventsRequest(); try { ShowInstanceScheduleEventsResponse response = client.showInstanceScheduleEvents(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("")) \ .build() try: request = ShowInstanceScheduleEventsRequest() response = client.show_instance_schedule_events(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.ShowInstanceScheduleEventsRequest{} response, err := client.ShowInstanceScheduleEvents(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=ShowInstanceScheduleEvents)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。