Querying Event Definitions
Function
This API is used to query event definitions.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/physicalservers/events/{event_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition The project ID. Constraints N/A Range The project ID of the account Default Value N/A |
event_id |
Yes |
String |
Event ID. |
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 |
---|---|---|
code |
String |
Definition Event code. Constraints N/A Range N/A Default Value N/A |
status |
String |
Definition Status. Constraints N/A Range N/A Default Value N/A |
name_cn |
String |
Definition Event name (in Chinese). Constraints N/A Range N/A Default Value N/A |
name_en |
String |
Definition Event name (in English). Constraints N/A Range N/A Default Value N/A |
effect_cn |
String |
Definition Event impact (in Chinese). Constraints N/A Range N/A Default Value N/A |
effect_en |
String |
Definition Event impact (in English). Constraints N/A Range N/A Default Value N/A |
suggestion_cn |
String |
Definition Event handling suggestion (in Chinese). Constraints N/A Range N/A Default Value N/A |
suggestion_en |
String |
Definition Event handling suggestion (in English). Constraints N/A Range N/A Default Value N/A |
reason_cn |
String |
Definition Event cause (in Chinese). Constraints N/A Range N/A Default Value N/A |
reason_en |
String |
Definition Event cause (in English). Constraints N/A Range N/A Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Status code: 429
Parameter |
Type |
Description |
---|---|---|
- |
String |
- |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Example Requests
Request for querying event definitions
GET https://{endpoint}/v1/{project_id}/physicalservers/events/{event_id}
Example Responses
Status code: 200
Event definitions returned.
{ "code" : "", "status" : "", "name_cn" : "", "name_en" : "", "effect_cn" : "", "effect_en" : "", "suggestion_cn" : "", "suggestion_en" : "", "reason_cn" : "", "reason_en" : "" }
Status Codes
Status Code |
Description |
---|---|
200 |
Event definitions are returned. |
400 |
Invalid request parameter. |
401 |
The request is not authenticated. |
429 |
The request is overloaded. |
500 |
Internal server error. |
Error Codes
For details, 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