Obtaining the Last Execution Status of a Scheduled Start/Stop Policy
Function
Obtain the last execution status of a scheduled start/stop policy.
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 Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
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.
|
|
X-Enterprise-Project-ID |
No |
String |
Enterprise project ID.
NOTE:
For details about how to obtain enterprise project IDs and enterprise project features, 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. |
|
kind |
String |
API type. Fixed value: TimerRule. |
|
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 |
Definition Policy execution result. Options: failed and success. Range
Default Value N/A |
|
error_message |
String |
Error information. If the execution is successful, this parameter is left blank. |
Example Requests
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 Responses
Status code: 200
OK
{
"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 Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
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