Help Center/ TaurusDB/ API Reference/ APIs/ Event Management/ Obtaining the Event List

Updated on 2026-08-31 GMT+08:00

View PDF

Obtaining the Event List

Function

This API is used to obtain the event list. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependency

gaussdbformysql:event:listScheduleEvents

List

-

-

gaussdb:event:listScheduleEvents

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
gaussdbformysql:event:listScheduleEvents	List	-	-	gaussdb:event:listScheduleEvents	-

URI

GET /v3/{project_id}/schedule-events

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
id	No	String	Definition Event ID. You can log in to the management console and view the event ID in the event management list. Constraints N/A Range The value contains 36 characters, starting with a UUID and ending with ev07. Only letters and digits are allowed. Default Value N/A
instance_id	No	String	Definition Instance ID, which uniquely identifies an instance. To obtain this value, see Querying DB Instances. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
status	No	String	Definition Event status. Constraints N/A Range inquiring: The event is to be authorized. scheduled: The event is to be executed. executing: The event is being executed. completed: The execution is completed. canceled: The event is closed. failed: The execution failed. Default Value N/A
type	No	String	Definition Event type. Constraints N/A Range system.lifecycle.rebuild_node: read replica rebuilding event system.lifecycle.db_upgrade: kernel minor version upgrade event system.scheduled_event.high_cpu_memory: high CPU or memory load event. The instance specifications need to be changed. Default Value N/A
level	No	String	Definition Event severity. Constraints N/A Range critical major minor info Default Value N/A
sort_field	No	String	Definition Sorting field of the response list. Constraints N/A Range created_time: sorting by creation time updated_time: sorting by update time execution_time_window: sorting by execution time window execute_time: sorting by execution time Default Value N/A
order	No	String	Definition Sorting order (ascending/descending) of the response list based on sort_field. Constraints This parameter is valid when sort_field is not left blank. Range asc: ascending order desc: descending order Default Value N/A
limit	No	Integer	Definition Number of records returned by a query. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 10
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be an integer and cannot be a negative number. Range ≥ 0 Default Value 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us: English zh-cn: Chinese Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition Total number of events. Range N/A
inquiring_count	Integer	Definition Number of events to be authorized. Range N/A
schedule_count	Integer	Definition Number of events to be executed. Range N/A
executing_count	Integer	Definition Number of events being executed. Range N/A
failed_count	Integer	Definition Number of events that failed to be executed. Range N/A
events	Array of ScheduleEventInfo objects	Definition Event details, including the event ID, event type, event status, event severity, instance information, and execution time.

**Table 5** ScheduleEventInfo
Parameter	Type	Description
id	String	Definition Event ID. Range The value contains 36 characters, starting with a UUID and ending with ev07. Only letters and digits are allowed.
category	String	Definition Event type. Range Maintenance: planned O&M event
impact	String	Definition Event impact. Range N/A
status	String	Definition Event status. Range inquiring: The event is to be authorized. scheduled: The event is to be executed. executing: The event is being executed. completed: The execution is completed. canceled: The event is closed. failed: The execution failed.
reason	String	Definition Event cause. Range N/A
level	String	Definition Event severity. Range critical major minor info
instance_id	String	Definition Instance ID. Range The value contains 36 characters, starting with a UUID and ending with in07. Only letters and digits are allowed.
instance_name	String	Definition Instance name. Range The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.
db_type	String	Definition Engine name. Range taurus: TaurusDB Enterprise Edition
created_time	String	Definition Creation time (UTC). The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Range N/A
updated_time	String	Definition Update time (UTC). The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Range N/A
type	String	Definition Event type. Range system.lifecycle.rebuild_node: read replica rebuilding event system.lifecycle.db_upgrade: kernel minor version upgrade event system.scheduled_event.high_cpu_memory: high CPU or memory load event. The instance specifications need to be changed.
extend_info	String	Definition Extended information. Range N/A
execute_time	String	Definition Event execution time (UTC). The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Range N/A
execution_time_window	Object	Definition Event execution window.
event_entities	Array of EventEntity objects	Definition Event object information list, including the event object ID and execution status.

**Table 6** ExecuteWindow
Parameter	Type	Description
planned_execution_day	String	Definition Planned execution date, in the format of yyyy-MM-dd. Range N/A
start_time	String	Definition Start time of the event execution window, in the format of hh:mm. Range N/A
end_time	String	Definition End time of the event execution window, in the format of hh:mm. Range N/A

**Table 7** EventEntity
Parameter	Type	Description
event_entity_id	String	Definition Event object ID. Range Instance ID or node ID. The value contains 36 characters with a suffix of in07 or no07. Only letters and digits are allowed.
event_entity_status	String	Definition Execution status of an event object. Range inquiring: The event is to be authorized. scheduled: The event is to be executed. executing: The event is being executed. completed: The execution is completed. canceled: The event is closed. failed: The execution failed.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying the event list

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/schedule-events?sort_field=end_time&limit=1&offset=0&status=completed&order=asc

Example Response

Status code: 200

Success.

{
  "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-30T00:05:00Z",
      "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,
  "inquering_count" : 0,
  "schedule_count" : 0,
  "executing_count" : 0,
  "failed_count" : 0
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Event Management

Previous topic: Event Management

Next topic: Performing Operations on Events