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

Obtaining the Scheduled Start/Stop Policy List

Function

This API is used to obtain the scheduled start/stop policy list.

URI

GET /v1/{project_id}/cae/timer-rules

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

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

items

Array of TimerRuleDetails objects

List of start/stop policies.

Table 4 TimerRuleDetails

Parameter

Type

Description

id

String

ID of a scheduled start/stop policy. This parameter is ignored during policy creation.

name

String

Name of a scheduled start/stop policy.

type

String

Policy type. Options: stop and start.

status

String

Policy status. Options: on and off.

env_id

String

Environment ID.

apps

Array of AppInfo objects

Applications to which the scheduled start/stop policy applies. This parameter is mandatory only when effective_range is set to application.

components

Array of ComponentInfo objects

Components to which the scheduled start/stop policy applies. This parameter is mandatory only when effective_range is set to component.

component_number

Integer

Number of components to which a scheduled start/stop policy applies. This parameter is ignored during policy creation.

cron

String

Cron expression.

effective_range

String

Scope to which a policy applies. Options: component, application, and environment.

effective_policy

String

Trigger mode. Options: onetime and periodic.

last_execution_status

String

Status of the last execution. Options: abnormal, normal, and executing. This parameter is ignored during policy creation.

Table 5 AppInfo

Parameter

Type

Description

app_id

String

Application ID.

app_name

String

Application name.

Table 6 ComponentInfo

Parameter

Type

Description

component_id

String

Component ID.

component_name

String

Component name.

Example Request

Obtain the scheduled start/stop policy list.

GET https://{endpoint}/v1/{project_id}/cae/timer-rules

Example Response

Status code: 200

The request is successful.

{
  "api_version" : "v1",
  "kind" : "TimerRule",
  "items" : [ {
    "id" : "string",
    "name" : "string",
    "type" : "start",
    "env_id" : "string",
    "cron" : "0 16 17 31 1 ? 2023",
    "component_number" : 2,
    "status" : "off",
    "last_execution_status" : "normal",
    "effective_range" : "application",
    "effective_policy" : "onetime",
    "apps" : [ {
      "app_id" : "string",
      "app_name" : "string"
    } ]
  }, {
    "id" : "string",
    "name" : "string",
    "type" : "start",
    "env_id" : "string",
    "cron" : "0 48 17 ? * * *",
    "component_number" : 2,
    "status" : "on",
    "last_execution_status" : "abnormal",
    "effective_range" : "environment",
    "effective_policy" : "periodic"
  }, {
    "id" : "string",
    "name" : "string",
    "type" : "stop",
    "env_id" : "string",
    "cron" : "0 16 17 31 1 ? 2023",
    "component_number" : 2,
    "status" : "off",
    "last_execution_status" : "executing",
    "effective_range" : "component",
    "effective_policy" : "onetime",
    "components" : [ {
      "component_id" : "string",
      "component_name" : "string"
    } ]
  } ]
}

Status Code

Status Code

Description

200

The request is successful.

Error Code

For details, see Error Codes.