文档首页/ 云应用引擎 CAE/ API参考/ CAE API/ 定时启停规则/ 获取上次定时启停规则的执行情况
更新时间:2024-11-14 GMT+08:00
分享

获取上次定时启停规则的执行情况

功能介绍

获取上次定时启停规则的执行情况。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/cae/timer-rules/{timer_rule_id}/execution-results

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取项目ID请参见获取项目ID

timer_rule_id

String

定时启停规则ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

  • 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。

  • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

String

企业项目ID。

  • 创建环境时,环境会绑定企业项目ID。

  • 最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。

  • 该字段不传(或传为字符串“0”)时,则查询默认企业项目下的资源。

说明:

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。

X-Environment-ID

String

环境ID。

  • 获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。

  • 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

api_version

String

API版本,固定值“v1”,该值不可修改。

kind

String

API类型,固定值“TimerRule”,该值不可修改。

spec

ExecutionDetails object

启停规则执行信息。

表4 ExecutionDetails

参数

参数类型

描述

last_execution_time

String

启停策略执行时间。

items

Array of ComponentExecutionResult objects

组件启停规则执行结果列表。

表5 ComponentExecutionResult

参数

参数类型

描述

component_name

String

组件名称。

component_id

String

组件ID。

status

String

组件执行启停的结果:failed/success。

error_message

String

组件执行启停的错误信息,如果执行结果为成功,则为空。

请求示例

获取上次定时启停规则的执行情况。

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

响应示例

状态码: 200

请求成功。

{
  "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",
      }
    ]
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码

相关文档