本产品（sae/2019-05-06）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
服务开通
|
API |
标题 |
API概述 |
| OpenSaeService | OpenSaeService | 免费开通SAE服务。 |
服务通用管理
|
API |
标题 |
API概述 |
| 命名空间和VPC | 命名空间和VPC | |
| CreateNamespace | 创建命名空间 | 创建命名空间 |
| CreateIngress | 创建一条路由规则 | 创建一条路由规则。 |
| DeleteNamespace | 删除命名空间 | 删除命名空间。 |
| DeleteIngress | 删除 ingress 实例 | 删除ingress实例。 |
| UpdateNamespace | 更新命名空间信息 | 更新命名空间信息。 |
| UpdateNamespaceVpc | 更新命名空间绑定的vpc | 调用UpdateNamespaceVpc接口更新命名空间绑定的VPC。 |
| UpdateApplicationVswitches | 更新交换机配置 | 更新交换机配置。 |
| UpdateIngress | 更新ingress实例配置 | 更新Ingress实例配置。 |
| DescribeNamespace | 查询命名空间详细信息 | 调用DescribeNamespace接口查询命名空间详细信息。 |
| DescribeNamespaces | 查询命名空间列表 | 调用DescribeNamespaces接口查询命名空间列表。 |
| DescribeNamespaceList | 获取命名空间列表 | 调用DescribeNamespaceList接口获取命名空间列表。 |
| ListAppEvents | 查看应用事件 | 调用ListAppEvents接口查看应用事件。 |
| ListNamespaceChangeOrders | 获取命名空间发布单列表 | 获取命名空间发布单列表。 |
| DescribeNamespaceResources | 查询命名空间内的资源信息 | 查询命名空间内的资源信息。 |
| DescribeIngress | 查询ingress配置详情 | 查询Ingress配置详情。 |
| ListIngresses | 获取ingress列表 | 调用ListIngresses接口获取Ingress列表。 |
| DescribePipeline | 获取Logstash实例的管道信息 | 查看批次信息。 |
| 概览页TOP N监控 | 概览页TOP N监控 | |
| GetArmsTopNMetric | GetArmsTopNMetric | 调用GetArmsTopNMetric接口获取应用监控的Top N应用列表。 |
| GetChangeOrderMetric | GetChangeOrderMetric | 调用GetChangeOrderMetric接口获取异常变更单的Top N 应用列表。 |
| GetScaleAppMetric | GetScaleAppMetric | 调用GetScaleAppMetric接口获取弹性生效的Top N应用列表。 |
| GetWarningEventMetric | GetWarningEventMetric | 调用GetWarningEventMetric接口获取Warning事件的Top N应用列表。 |
微服务应用
|
API |
标题 |
API概述 |
| 应用生命周期 | 应用生命周期 | |
| CreateApplication | 创建一个SAE应用 | 创建一个应用。 |
| DeleteApplication | 删除应用 | 调用DeleteApplication接口删除应用。 |
| DeleteInstances | 删除实例 | 删除应用实例。 |
| StopApplication | 停止应用 | 停止应用。 |
| StartApplication | 启动应用 | 调用StartApplication接口启动应用。 |
| ReduceApplicationCapacityByInstanceIds | 应用缩容 | 根据实例ID缩容。 |
| UpdateApplicationDescription | 更新应用描述 | 更新应用描述。 |
| UpdateAppSecurityGroup | 更新应用安全组 | 调用UpdateAppSecurityGroup接口更新应用安全组。 |
| DescribeApplicationStatus | 获取应用的状态信息 | 调用DescribeApplicationStatus接口获取应用的状态信息。 |
| ListChangeOrders | 获取变更单列表 | 获取变更单列表。 |
| DescribeChangeOrder | 查询变更单信息 | 调用DescribeChangeOrder接口查询变更单信息。 |
| DescribeInstanceSpecifications | 获取应用实例规格信息 | 调用DescribeInstanceSpecifications接口获取应用实例规格信息。 |
| DeployApplication | 部署应用 | 部署应用。 |
| RescaleApplicationVertically | 改变应用实例规格 | 更改应用实例规格。 |
| ConfirmPipelineBatch | 是否开始一下批次 | 确认是否开始下一批次。 |
| AbortAndRollbackChangeOrder | 中止或回滚变更单 | 调用AbortAndRollbackChangeOrder接口终止或回滚变更单。 |
| RescaleApplication | 应用扩缩容 | 完成应用扩缩容。 |
| RestartApplication | 重启应用 | 调用RestartApplication接口重启应用。 |
| AbortChangeOrder | 中止变更单 | 调用AbortChangeOrder接口终止变更单。 |
| RollbackApplication | 回退应用历史版本 | 调用RollbackApplication接口回退应用历史版本。 |
| BatchStopApplications | 批量停止应用 | 批量停止应用。 |
| BatchStartApplications | 批量启动应用 | 批量启动应用。 |
| DowngradeApplicationApmService | 关闭ARMS高级版监控 | 关闭ARMS高级版监控。 |
| UpgradeApplicationApmService | 开通ARMS高级版监控 | 开通ARMS高级版监控。 |
| 微服务列表 | 微服务列表 | |
| ListConsumedServices | 获取订阅的微服务列表 | 调用ListConsumedServices接口获取订阅的微服务列表。 |
| ListPublishedServices | 获取发布的微服务列表 | 调用ListPublishedServices接口获取发布的微服务列表。 |
| ListAppServices | 查询微服务的服务列表 | 查询微服务的服务列表。 |
| 保密字典管理 | 保密字典管理 | |
| CreateSecret | CreateSecret | 创建命名空间中的Secret实例。 |
| DescribeSecret | 查询Secret实例详情 | 查询Secret实例详情。 |
| ListSecrets | ListSecrets | 调用ListSecrets接口获取命名空间内Secret实例列表。 |
| UpdateSecret | UpdateSecret | 调用UpdateSecret接口更新Secret实例。 |
| DeleteSecret | DeleteSecret | 调用DeleteSecret接口删除Secret实例。 |
| 标签管理 | 标签管理 | |
| ListTagResources | 查询应用和标签的对应关系 | 调用ListTagResources接口查询应用和标签的对应关系。 |
| UntagResources | 移除指定资源和标签之间的绑定关系 | 调用UntagResources接口解除指定资源和标签之间的绑定关系。 |
| TagResources | 给指定的资源打上标签 | 调用TagResources接口为指定资源添加标签。 |
| 配置项管理 | 配置项管理 | |
| CreateConfigMap | 创建ConfigMap实例 | 创建命名空间中的ConfigMap实例。 |
| DeleteConfigMap | 删除ConfigMap实例 | 调用DeleteConfigMap接口删除ConfigMap实例。 |
| UpdateConfigMap | 更新ConfigMap实例 | 更新ConfigMap实例。 |
| DescribeConfigMap | 查询ConfigMap实例详情 | 调用DescribeConfigMap接口查询ConfigMap实例详情。 |
| ListNamespacedConfigMaps | 获取ConfigMap实例列表 | 获取命名空间内ConfigMap实例列表。 |
| 灰度标签路由 | 灰度标签路由 | |
| CreateGreyTagRoute | CreateGreyTagRoute | 为Spring Cloud或Dubbo应用创建灰度规则。 |
| DeleteGreyTagRoute | DeleteGreyTagRoute | 根据规则ID删除灰度规则。 |
| UpdateGreyTagRoute | UpdateGreyTagRoute | 更新灰度规则。 |
| DescribeGreyTagRoute | DescribeGreyTagRoute | 根据规则ID查询灰度规则详情。 |
| ListGreyTagRoute | ListGreyTagRoute | 根据应用ID查询灰度规则详情。 |
| 全链路灰度 | 全链路灰度 | |
| CreateOrUpdateSwimmingLaneGroup | 创建或更新泳道组 | 创建或者更新泳道组。 |
| CreateOrUpdateSwimmingLane | 创建或更新泳道 | 创建或者更新泳道。 |
| ListApplicationsForSwimmingLane | 查询泳道组应用列表 | 获取应用列表，供全链路灰度拉取应用列表。 |
| ListSwimmingLaneGatewayRoutes | 查询泳道可选的网关路由 | 查询泳道可选的网关路由 |
| ListSwimmingLaneGroupTags | 查询所有泳道标签列表 | 查询所有泳道标签列表。 |
| DescribeSwimmingLane | 查询泳道详情 | 查询泳道详情。 |
| ListAllSwimmingLanes | 查询所有泳道 | 查询所有泳道。 |
| ListAllSwimmingLaneGroups | 查询所有泳道组 | 查询所有泳道组。 |
| DeleteSwimmingLaneGroup | 删除泳道组 | 删除泳道组。 |
| UpdateSwimmingLaneEnableAttribute | 更新泳道的启用属性 | 更新泳道的启用属性。 |
| 应用信息查询 | 应用信息查询 | |
| GetApplication | 查询应用基本信息 | 查询应用基本信息。 |
| DescribeApplicationConfig | 获取应用配置信息 | 获取应用配置信息。 |
| DescribeRegions | 查询可用地域 | 调用DescribeRegions接口查询可用地域。 |
| DescribeInstanceLog | 获取实例日志 | 获取实例日志。 |
| DescribeComponents | 获取应用创建部署时所需的组件版本 | 调用DescribeComponents接口获取应用创建部署时所需的组件版本。 |
| DescribeEdasContainers | 获取应用微服务容器组件列表 | 调用DescribeEdasContainers接口获取应用微服务容器组件列表。 |
| DescribeApplicationImage | 描述应用镜像信息 | 调用DescribeApplicationImage接口描述应用镜像信息。 |
| DescribeApplicationInstances | 获取应用实例列表 | 获取应用实例列表。 |
| DescribeApplicationGroups | 获取应用实例分组 | 调用DescribeApplicationGroups接口获取应用实例分组。 |
| ListApplications | 获取应用列表 | 获取应用列表。 |
| QueryResourceStatics | 获取应用的资源使用量 | 获取应用的资源使用量。 |
| ListLogConfigs | 获取应用日志列表 | 获取应用日志列表。 |
| ListAppVersions | 查看应用的历史版本 | 查看应用的历史版本。 |
| RestartInstances | 重启应用实例 | 调用RestartInstances接口重启应用实例。 |
| GetAvailabilityMetric | GetAvailabilityMetric | 调用GetAvailabilityMetric接口获取实例总数异常的Top N应用列表。 |
| DescribeAppServiceDetail | DescribeAppServiceDetail | 获取应用服务的元数据详情。 |
| ListAppServicesPage | ListAppServicesPage | 调用ListAppServicesPage接口获取应用服务列表。 |
| SLB管理 | SLB管理 | |
| DescribeApplicationNlbs | 查看应用绑定的NLB配置 | 查看应用绑定的NLB配置。 |
| BindNlb | 为应用绑定NLB | 应用访问支持NLB |
| DescribeApplicationSlbs | 获取应用SLB配置信息 | 获取应用SLB配置信息。 |
| BindSlb | 为应用绑定SLB | 为应用绑定SLB。 |
| UnbindSlb | 解绑内网或公网SLB | 调用UnbindSlb接口解绑私网或公网SLB。 |
| UnbindNlb | 应用访问删除NLB监听 | 调用UnbindNlb删除应用访问绑定的NLB监听 |
| 应用伸缩规则 | 应用伸缩规则 | |
| CreateApplicationScalingRule | 创建应用弹性伸缩策略 | 创建应用弹性伸缩策略。 |
| DeleteApplicationScalingRule | DeleteApplicationScalingRule | 调用CreateApplicationScalingRule接口删除应用弹性伸缩策略。 |
| DisableApplicationScalingRule | 禁用应用弹性伸缩策略 | 调用DisableApplicationScalingRule接口禁用应用弹性伸缩策略。 |
| EnableApplicationScalingRule | EnableApplicationScalingRule | 启用应用弹性伸缩策略。 |
| UpdateApplicationScalingRule | 修改弹性策略 | 更新应用弹性伸缩策略。 |
| DescribeApplicationScalingRule | 查询应用的单个弹性伸缩策略 | s接口查询应用的单个弹性伸缩策略。 |
| DescribeApplicationScalingRules | 查询应用弹性伸缩策略 | 查询应用弹性伸缩策略。 |
Job任务
|
API |
标题 |
API概述 |
| CreateJob | 创建任务模板 | 创建任务模板。 |
| DeleteHistoryJob | DeleteHistoryJob | 删除任务。 |
| DeleteJob | DeleteJob | 删除任务模板。 |
| DescribeJobStatus | DescribeJobStatus | 调用DescribeJobStatus接口查询任务状态。 |
| DescribeJob | 获取任务模板配置信息 | 调用DescribeJob接口获取任务模板配置信息。 |
| ExecJob | ExecJob | 调用ExecJob接口执行任务 |
| ListJobs | ListJobs | 调用ListJobs接口获取任务模板列表。 |
| SuspendJob | 启动或暂停任务 | 暂停任务。 |
| UpdateJob | UpdateJob | 调用UpdateJob接口更新任务模板。 |
| DescribeJobHistory | DescribeJobHistory | 调用DescribeJobHistory接口查询任务记录。 |
其他
|
API |
标题 |
API概述 |
| DescribeConfigurationPrice | 查询配置价格信息 | 查询configurationprice。 |
| GetWebshellToken | 获取远程登录Token | 获取远程登录实例 Web Shell 的 Token。 |
| UpdateAppMode | 更新应用闲置模式 | 应用闲置模式更新 |
| QueryArmsEnable | 查询应用监控开启状态 | 查询指定app是否开启应用监控。 |
| DescribeApplicationMseService | 查询关联的MSE微服务治理应用 | 查询应用关联的MSE微服务治理应用信息 |
| BatchRestartApplications | 批量重启应用 | 批量重启应用 |
| UpdateNamespaceSlsConfigs | 更新命名空间的sls配置 | 更新命名空间级别sls配置 |
| DisableArms | DisableArms | 停止Arms监控。 |
| ResumeTraffic | 恢复实例的流量 | 将实例上来自 CLB 应用访问、NLB 应用访问、CLB 网关路由、ALB 网关路由、K8S Service 上的流量恢复 |
| SuspendTraffic | 将流量从实例摘除 | 将实例上来自 CLB 应用访问、NLB 应用访问、CLB 网关路由、ALB 网关路由、K8S Service 上的流量摘除 |
该文章对您有帮助吗？