Help Center/ Cloud Application Engine/ API Reference/ CAE API/ Scheduled Start/Stop Policy/ Obtaining the Last Execution Status of a Scheduled Start/Stop Policy
Updated on 2025-02-14 GMT+08:00

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

Table 1 Path parameters

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

Table 2 Request header 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.

  • When an environment is created, it will be bound with an enterprise project ID.
  • Enter 0 or up to 36 characters in UUID format with hyphens (-).
  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.
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

Table 3 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

Enumerated value:

  • v1

kind

String

API type. Fixed value: TimerRule.

Enumerated value:

  • TimerRule

spec

ExecutionDetails object

Policy execution details.

Table 4 ExecutionDetails

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.

Table 5 ComponentExecutionResult

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.