本文导读

环境接口
卷接口
应用接口
组件接口
组件配置接口
委托接口
任务接口
域名接口
证书接口
定时启停规则接口
弹性公网IP接口
监控系统接口
Secret

展开导读

文档首页/ 云应用引擎 CAE/ API参考/ API概览

API概览

更新时间：2025-02-14 GMT+08:00

查看PDF

CAE API为符合API设计规范的自研接口。

环境接口

表1 环境接口介绍
API	说明
获取环境列表	此API用来获取当前项目下的环境列表。
创建环境	此API用来创建环境。
删除环境	此API用来删除对应的环境。

卷接口

表2 卷接口介绍
API	说明
获取云存储列表	此API用来获取当前环境下的卷列表。
授权云存储	此API用来创建卷。
解绑云存储	此API用来删除对应的卷。

应用接口

表3 应用接口介绍
API	说明
获取应用列表	此API用来获取当前环境下的应用列表。
创建应用	此API用来创建应用。
获取应用详情	此API用来获取对应的应用。
删除应用	此API用来删除对应的应用。

组件接口

表4 组件接口介绍
API	说明
创建组件	此API用来创建组件。
获取组件列表	此API用来获取当前环境下对应应用的组件列表。
获取组件详情	此API用来获取对应的组件。
更新组件	此API用来更新对应的组件。
删除组件	此API用来删除对应的组件。
操作组件	此API用来操作对应的组件，如部署、升级、配置、回滚、重启、停止等操作。
获取组件快照列表	此API用来获取组件的快照列表。
获取组件实例列表	此API用来组件实例。

组件配置接口

表5 组件配置接口介绍
API	说明
获取组件配置列表	此API用来获取组件配置列表。
创建组件配置	此API用来创建组件配置。
删除组件配置	此API用来删除对应的组件的配置。

委托接口

表6 委托接口介绍
API	说明
获取委托列表	此API用来获取当前用户的委托列表。
创建委托	此API用来创建委托。

任务接口

表7 任务接口介绍
API	说明
获取任务详情	此API用来获取对应任务。
重试任务	此API用来重试任务。

域名接口

表8 域名接口介绍
API	说明
获取域名列表	此API用来获取域名列表。
创建域名	此API用来创建域名。
删除域名	此API用来删除域名。

证书接口

表9 证书接口介绍
API	说明
获取证书列表	此API用来获取证书列表。
创建证书	此API用来创建证书。
修改证书	此API用来修改证书。
删除证书	此API用来删除证书。

定时启停规则接口

**表10** 定时启停规则接口介绍
API	说明
获取定时启停规则列表	此API用来获取定时启停规则列表。
创建定时启停规则	此API用来创建定时启停任务。
删除定时启停规则	此API用来删除定时启停规则。
修改定时启停规则	此API用来修改定时启停规则。
获取上次定时启停规则的执行情况	此API用来获取上次定时启停规则的执行情况。

弹性公网IP接口

**表11** 弹性公网IP接口介绍
API	说明
获取集群节点弹性公网IP列表	此API用来获取集群节点弹性公网IP列表。
修改带宽	此API用来修改带宽。

监控系统接口

**表12** 监控系统接口介绍
API	说明
获取监控系统配置	此API用来获取监控系统配置。
创建监控系统配置	此API用来创建监控系统配置。
更新监控系统配置	此API用来更新监控系统配置。

Secret

**表13** Secret接口介绍
API	说明
关联租户已注册的凭据	此API用来关联租户已注册的凭据。
获取用户现有的凭据	此API用来获取用户现有的凭据。
修改用户已在DEW服务上注册的凭据版本	此API用来修改用户已在DEW服务上注册的凭据版本。
删除用户已在DEW服务上注册的凭据	此API用来删除用户已在DEW服务上注册的凭据。
获取当前正在使用对应凭据组件列表	此API用来获取当前正在使用对应凭据组件列表。

上一篇：基本概念

下一篇：如何调用API

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容

直接提交取消