Querying Server Event List
Function
This API is used to query the server event list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/physicalservers/events
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Definition Project ID. Constraints N/A Range Project ID of the account. Default Value N/A |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
offset | No | Integer | Definition Pagination cursor. Constraints N/A Range N/A Default Value N/A |
limit | No | Integer | Definition The number of records on each page. Constraints N/A Range N/A Default Value N/A |
event_level | No | String | Definition Event severity. Constraints N/A Range
Default Value N/A |
resource_id | No | String | Definition ID of the resource for which the alarm was generated. Constraints N/A Range N/A Default Value N/A |
from | Yes | Integer | Definition The query start timestamp, in milliseconds. Constraints from must be earlier than to, and the query time range cannot exceed 30 days. Range The value is a timestamp. Default Value N/A |
to | Yes | Integer | Definition The query end timestamp, in milliseconds. Constraints from must be earlier than to, and the query time range cannot exceed 30 days. Range The value is a timestamp. Default Value N/A |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | Definition Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
events | Array of EventInfo objects | Definition Objects of the event list. Constraints N/A |
count | Integer | Definition The total number of events in the list. Constraints N/A Range N/A Default Value N/A |
Parameter | Type | Description |
|---|---|---|
event_id | String | Definition Event ID. Constraints N/A Range N/A Default Value N/A |
message_id | String | Definition Message ID of the event. Constraints N/A Range N/A Default Value N/A |
event_message | String | Definition Event description. Constraints N/A Range N/A Default Value N/A |
event_level | String | Definition Event severity. Constraints N/A Range
Default Value N/A |
status | String | Definition Event status. Constraints N/A Range
Default Value N/A |
resource_id | String | Definition Resource ID. Constraints N/A Range Maximum length: 128 bytes Default Value N/A |
time | Integer | Definition Time when the event occurred. The value is a Unix timestamp, in milliseconds. Constraints N/A Range Unix timestamp. Default Value N/A |
origin_event | String | Definition Original events reported by BMC. Constraints N/A Range Maximum length: 4,096 bytes Default Value N/A |
Status code: 400
Parameter | Type | Description |
|---|---|---|
error_code | String | Definition Error code. |
error_msg | String | Definition Error description. |
Status code: 401
Parameter | Type | Description |
|---|---|---|
error_code | String | Definition Error code. |
error_msg | String | Definition Error description. |
Status code: 429
Parameter | Type | Description |
|---|---|---|
- | String |
Status code: 500
Parameter | Type | Description |
|---|---|---|
error_code | String | Definition Error code. |
error_msg | String | Definition Error description. |
Example Requests
Querying the server event list
GET https://{endpoint}/v1/{project_id}/physicalservers/events Example Responses
Status code: 200
Server event list is returned.
{
"events" : [ ],
"count" : 0
} Status Codes
Status Code | Description |
|---|---|
200 | Server event list is returned. |
400 | Invalid request parameter. |
401 | The request is not authenticated. |
429 | The request is overloaded. |
500 | Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
