华为云首页用户手册

云应用引擎 CAE-创建定时启停规则:请求参数

云应用引擎 CAE-创建定时启停规则:请求参数

时间：2023-11-20 10:32:01

云应用引擎 CAE

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。最大长度：16384
X-Enterprise-Project-ID	否	String	企业项目ID。创建环境时，环境会绑定企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。说明：关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。
X-Environment-ID	是	String	环境ID。获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

表3 请求Body参数
参数	是否必选	参数类型	描述
api_version	否	String	API版本，固定值“v1”，该值不可修改。枚举值： v1
kind	否	String	API类型，固定值“TimerRule”，该值不可修改。枚举值： TimerRule
spec	否	UpdateTimerRuleDetails object	启停规则规格信息。

表4 UpdateTimerRuleDetails
参数	是否必选	参数类型	描述
name	是	String	定时启停规则名称。
type	是	String	定时启停规则的类型：stop/start。
status	是	String	定时启停规则状态（是否开启）：on/off。
apps	否	Array of AppInfo objects	定时启停规则所包含的所有应用，只在生效范围为application的时候需要填写。
components	否	Array of ComponentInfo objects	在定时启停规则所包含的所有组件，只在生效范围为component的时候需要填写。
cron	是	String	cron表达式。
effective_range	是	String	定时启停规则生效范围: component/application/environment。
effective_policy	是	String	定时启停规则的定时类别: onetime/periodic。

表5 AppInfo
参数	是否必选	参数类型	描述
app_id	否	String	应用ID。
app_name	否	String	应用名称。

表6 ComponentInfo
参数	是否必选	参数类型	描述
component_id	否	String	组件ID。
component_name	否	String	组件名称。

上一篇：云应用引擎 CAE-创建定时启停规则:响应参数

下一篇：云应用引擎 CAE-创建定时启停规则:响应参数

云应用引擎 CAE-创建定时启停规则:请求参数

意见反馈

0/200

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

推荐文章

解决方案
相关专题