- 最新动态
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
-
最佳实践
- CAE最佳实践汇总
- 使用CAE托管Nginx静态文件服务器
- Gitlab对接Jenkins自动构建并部署到CAE
- Jenkins流水线支持多组件按照依赖顺序部署
- SpringCloud应用部署到CAE自动对接Nacos引擎
- Spring Cloud应用无损上线
- 健康检查
- 生命周期管理
- 发送事件告警到企业微信
- 对接软件开发生产线CodeArts流水线自动升级到CAE
- 通过配置PromQL实现自定义弹性伸缩
- 配置CAE对接DEW，帮助应用从DEW获取加密凭据
- ASP.NET Core应用部署到CAE
- 通过企业路由打通网络
- CAE安全最佳实践
- 配置CodeArts对接CAE
- 通过事件网格（EG）实现端到端RDS凭证自动轮转
- CAE应用通过NAT网关实现公网及跨VPC访问
- API参考
- SDK参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
获取定时启停规则列表
功能介绍
获取定时启停规则列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/cae/timer-rules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取项目ID请参见获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。
|
|
X-Enterprise-Project-ID |
否 |
String |
企业项目ID。
|
|
X-Environment-ID |
是 |
String |
环境ID。
|
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
api_version |
String |
API版本，固定值“v1”，该值不可修改。 |
|
kind |
String |
API类型，固定值“TimerRule”，该值不可修改。 |
|
items |
Array of TimerRuleDetails objects |
启停规则列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
定时启停规则ID，在创建定时启停规则时会忽略。 |
|
name |
String |
定时启停规则名称。 |
|
type |
String |
定时启停规则的类型：stop/start。 |
|
status |
String |
定时启停规则状态（是否开启）：on/off。 |
|
env_id |
String |
环境ID。 |
|
apps |
Array of AppInfo objects |
定时启停规则所包含的所有应用，只在生效范围为application的时候需要填写。 |
|
components |
Array of ComponentInfo objects |
在定时启停规则所包含的所有组件，只在生效范围为component的时候需要填写。 |
|
component_number |
Integer |
定时启停规则包含的组件个数，在创建定时启停规则时会忽略。 |
|
cron |
String |
cron表达式。 |
|
effective_range |
String |
定时启停规则生效范围: component/application/environment。 |
|
effective_policy |
String |
定时启停规则的定时类别: onetime/periodic。 |
|
last_execution_status |
String |
上次执行的状态：abnormal/normal/executing，在创建定时启停规则时会忽略。 |
请求示例
获取定时启停规则列表。
GET https://{endpoint}/v1/{project_id}/cae/timer-rules响应示例
状态码：200
请求成功。
{
"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"
} ]
} ]
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
错误码
请参见错误码。
