Obtaining the Last Execution Status of a Scheduled Start/Stop Policy
Function
This API is used to obtain the last execution status of a scheduled start/stop policy.
URI
GET /v1/{project_id}/cae/timer-rules/{timer_rule_id}/execution-results
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. See Obtaining a Project ID. |
timer_rule_id |
Yes |
String |
ID of a scheduled start/stop policy. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token.
Maximum characters: 16,384 |
X-Enterprise-Project-ID |
No |
String |
Enterprise project ID.
NOTE:
For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide. |
X-Environment-ID |
Yes |
String |
Environment ID.
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
api_version |
String |
API version. Fixed value: v1. Enumerated value:
|
kind |
String |
API type. Fixed value: TimerRule. Enumerated value:
|
spec |
ExecutionDetails object |
Policy execution details. |
Parameter |
Type |
Description |
---|---|---|
last_execution_time |
String |
Time when the start/stop policy is executed. |
items |
Array of ComponentExecutionResult objects |
List of start/stop policy execution results. |
Parameter |
Type |
Description |
---|---|---|
component_name |
String |
Component name. |
component_id |
String |
Component ID. |
status |
String |
Policy execution result. Options: failed and success. |
error_message |
String |
Error information. If the execution is successful, this parameter is left blank. |
Example Request
Obtain the last execution status of a scheduled start/stop policy.
GET https://{endpoint}/v1/{project_id}/cae/timer-rules/{rule_id}/execution-results
Example Response
Status code: 200
The request is successful.
{ "api_version": "v1", "kind": "TimerRule", "spec": { "last_execution_time": "string", "items": [ { "component_name": "string", "component_id": "string", "status": "normal", "error_message": "", }, { "component_name": "string", "component_id": "string", "status": "abnormal", "error_message": "string", } ] } }
Status Code
Status Code |
Description |
---|---|
200 |
The request is successful. |
Error Code
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