更新时间:2025-10-31 GMT+08:00
分享

API概览

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

环境接口

表1 环境接口介绍

API

说明

获取环境列表 - ListEnvironments

此API用来获取当前项目下的环境列表。

创建环境 - CreateEnvironment

此API用来创建环境。

删除环境 - DeleteEnvironment

此API用来删除对应的环境。

云存储接口

表2 卷接口介绍

API

说明

获取云存储列表 - ListVolumes

此API用来获取云存储列表。

授权云存储 - CreateVolume

此API用来授权云存储。

解绑云存储 - DeleteVolume

此API用来解绑对应的云存储。

应用接口

表3 应用接口介绍

API

说明

获取应用列表 - ListApplications

此API用来获取当前环境下的应用列表。

创建应用 - CreateApplication

此API用来创建应用。

获取应用详情 - ShowApplication

此API用来获取对应的应用。

删除应用 - DeleteApplication

此API用来删除对应的应用。

组件接口

表4 组件接口介绍

API

说明

创建组件 - CreateComponent

此API用来创建组件。

获取组件列表 - ListComponents

此API用来获取当前环境下对应应用的组件列表。

获取组件详情 - ShowComponent

此API用来获取对应的组件。

更新组件 - UpdateComponent

此API用来更新对应的组件。

删除组件 - DeleteComponent

此API用来删除对应的组件。

创建、生效配置并部署组件 - CreateComponentWithConfiguration

此API用来创建、生效配置并部署对应的组件。

操作组件 - ExecuteAction

此API用来操作对应的组件,如部署、升级、配置、回滚、重启、停止等操作。

获取组件快照列表 - ListComponentSnapshots

此API用来获取组件的快照列表。

获取组件实例列表 - ListComponentInstances

此API用来获取组件实例列表。

组件配置接口

表5 组件配置接口介绍

API

说明

获取组件配置列表 - ListComponentConfigurations

此API用来获取组件配置列表。

创建组件配置 - CreateComponentConfiguration

此API用来创建组件配置。

删除组件配置 - DeleteComponentConfiguration

此API用来删除对应的组件的配置。

委托接口

表6 委托接口介绍

API

说明

获取委托列表 - ListAgencies

此API用来获取当前用户的委托列表。

创建委托 - CreateAgency

此API用来创建委托。

任务接口

表7 任务接口介绍

API

说明

获取任务详情 - ShowJob

此API用来获取对应任务。

重试任务 - RetryJob

此API用来重试任务。

域名接口

表8 域名接口介绍

API

说明

获取域名列表 - ListDomains

此API用来获取域名列表。

创建域名 - CreateDomain

此API用来创建域名。

删除域名 - DeleteDomain

此API用来删除域名。

证书接口

表9 证书接口介绍

API

说明

获取证书列表 - ListCertificates

此API用来获取证书列表。

创建证书 - CreateCertificate

此API用来创建证书。

修改证书 - UpdateCertificate

此API用来修改证书。

删除证书 - DeleteCertificate

此API用来删除证书。

定时启停规则接口

表10 定时启停规则接口介绍

API

说明

获取定时启停规则列表 - ListTimerRules

此API用来获取定时启停规则列表。

创建定时启停规则 - CreateTimerRule

此API用来创建定时启停任务。

删除定时启停规则 - DeleteTimerRule

此API用来删除定时启停规则。

修改定时启停规则 - UpdateTimerRule

此API用来修改定时启停规则。

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

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

弹性公网IP接口

表11 弹性公网IP接口介绍

API

说明

获取集群节点弹性公网IP列表 - ListEips

此API用来获取集群节点弹性公网IP列表。

修改出入网带宽以及开闭状态 - UpdateEip

此API用来修改宽带。

监控系统接口

表12 监控系统接口介绍

API

说明

获取监控系统配置 - ShowMonitorSystem

此API用来获取监控系统配置。

创建监控系统配置 - CreateMonitorSystem

此API用来创建监控系统配置。

更新监控系统配置 - UpdateMonitorSystem

此API用来更新监控系统配置。

CAE环境访问VPC接口

表13 CAE环境访问VPC接口介绍

API

说明

获取CAE环境访问VPC配置 - ListVpcEgress

此API用来关联租户已注册的凭据。

创建CAE环境访问VPC配置 - CreateVpcEgress

此API用来获取用户现有的凭据。

删除CAE环境访问VPC配置 - DeleteVpcEgress

此API用来修改用户已在DEW服务上注册的凭据版本。

事件通知规则接口

表14 事件通知规则接口介绍

API

说明

创建事件通知规则 - CreateNoticeRule

此API用来关联租户已注册的凭据。

查询事件通知规则列表 - ListNoticeRules

此API用来获取用户现有的凭据。

修改事件通知规则 - UpdateNoticeRule

此API用来修改用户已在DEW服务上注册的凭据版本。

查询事件通知规则 - ShowNoticeRule

此API用来删除用户已在DEW服务上注册的凭据。

删除事件通知规则 - DeleteNoticeRule

此API用来获取当前正在使用对应凭据组件列表。

Secret接口

表15 Secret接口介绍

API

说明

关联租户已注册的凭据 - CreateSecret

此API用来关联租户已注册的凭据。

获取用户现有的凭据 - ListSecrets

此API用来获取用户现有的凭据。

修改用户已在DEW服务上注册的凭据版本 - UpdateSecret

此API用来修改用户已在DEW服务上注册的凭据版本。

删除用户已在DEW服务上注册的凭据 - DeleteSecret

此API用来删除用户已在DEW服务上注册的凭据。

获取当前正在使用对应凭据组件列表 - ListEffectiveComponents

此API用来获取当前正在使用对应凭据组件列表。

相关文档