Obtaining Events That Users Can Subscribe To

Function

This API is used to obtain the events that users can subscribe to.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/event-list

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 64 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. For details, see Token-based Authentication. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
count	Integer	Definition Number of events that can be subscribed to Constraints N/A Range N/A Default Value 9
events	Array of GetEventListResultResponse objects	Definition Event type parameter list Constraints N/A Range N/A Default Value N/A

**Table 4** GetEventListResultResponse
Parameter	Type	Description
severity	Integer	Definition Event level, which can be normal or warning Constraints N/A Range 0: normal 1: warning Default Value N/A
category	Integer	Definition Event source type, which can be tenant, task, or stream Constraints N/A Range 0: tenant 1: stream 2: task Default Value N/A
type_name	String	Definition Event name Constraints N/A Range Dump task restored: dump task restoration Dump task abnormal: abnormal dump task Quota insufficient: insufficient quota Traffic limited: traffic limited Auto scaling succeeded: automatic stream scaling success Auto scaling failed: automatic stream scaling failure Stream Traffic Abnormal: abnormal stream traffic Stream Traffic Recovery: stream traffic recovery Manual scaling failed: manual stream scaling failure Default Value N/A
type_id	String	Definition Time ID corresponding to the event name. The ID is fixed and unique. Constraints N/A Range dis_event.000: dump task restoration dis_event.001: abnormal dump task dis_event.002: insufficient quota dis_event.003: limited traffic dis_event.004: auto scaling success dis_event.005: auto scaling failure dis_event.006: abnormal stream traffic dis_event.007: stream traffic recovery dis_event.008: manual scaling failure Default Value N/A

Example Requests

Obtain the events that users can subscribe to.

GET https://{Endpoint}/v1/{project_id}/event-list

Example Responses

Status code: 200

Normal response

{
  "count" : 9,
  "events" : {
    "severity" : 0,
    "category" : 2,
    "type_name" : "Dump task restored",
    "type_id" : "dis_event.000",
    "occur_time" : 0
  }
}