文档

API概览

更新时间:
本产品(弹性算法服务 EAS/2021-07-01)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

服务

API标题API概述
CreateService创建服务创建PAI-EAS服务。
CreateServiceAutoScaler开通服务自动扩缩容开通服务自动扩缩容功能,为服务创建自动扩缩控制器。
CreateServiceCronScaler开通服务定时扩缩容开通服务定时扩缩容功能。
CreateServiceMirror开通服务流量镜像开启服务流量镜像功能,可以将一个服务接受到的请求镜像到另一个服务上。
CreateAppService创建应用服务创建应用服务。
CloneService复制服务复制服务。
DeleteService删除服务删除指定的服务。
DeleteServiceLabel删除服务标签删除已有的服务标签。
DeleteServiceAutoScaler关闭服务自动扩缩容删除服务已有的弹性伸缩控制器,关闭自动弹性伸缩功能。
DeleteServiceCronScaler关闭服务定时扩缩容关闭服务定时扩缩容功能。
DeleteServiceInstances重启服务实例调用DeleteServiceInstances重启服务的指定实例。
DeleteServiceMirror关闭服务流量镜像关闭服务流量镜像功能。
UpdateService更新服务用于服务的模型或Processor更新。如果只更新metadata.instance字段,则用于服务扩缩容功能。
UpdateServiceLabel更新服务标签新增服务标签,或更新已有的服务标签。
StartService启动服务启动一个已停止状态的服务。
StopService停止服务停止一个运行中的服务。
RestartService重启服务重启服务。
UpdateServiceAutoScaler更新服务自动扩缩容配置修改服务已有的自动扩缩控制器配置。
UpdateServiceCronScaler更新服务定时扩缩容配置更新服务定时扩缩容配置信息。
DevelopService开发服务将容器服务转为开发模式,或退出开发模式。
CommitServiceCommit容器并发布Commit自定义容器服务中的Worker0容器,并作为新镜像重新部署服务。
UpdateServiceMirror更新服务流量镜像配置更新服务流量镜像配置。
UpdateServiceVersion切换服务版本更新服务的当前版本,用于服务在历史版本的切换,可实现回滚功能。
UpdateServiceSafetyLock更新服务安全锁更新服务安全锁,可以一定程度上避免对服务的误操作。
UpdateServiceInstance更新服务实例属性更新服务实例属性,目前只支持隔离服务实例。
UpdateAppService更新应用服务更新应用服务。
ReleaseService调整服务蓝绿发布流量比例执行分组发布或蓝绿发布切流。
DescribeService查询服务详情获取指定服务的详细信息。
DescribeServiceAutoScaler查看服务自动扩缩容信息查看服务的自动扩缩配置详情。
DescribeServiceCronScaler查看服务定时扩缩容信息查看服务的定时扩缩容配置详情。
DescribeServiceDiagnosis查看服务诊断详情查看服务的诊断详情。
DescribeServiceInstanceDiagnosis查看服务实例诊断详情查看服务实例的诊断详情。
DescribeServiceLog查看服务日志获取指定服务的日志信息。
DescribeServiceEvent查询服务事件查询服务近期部署事件。
DescribeServiceMirror查看服务流量镜像信息查看指定服务的流量镜像配置详情。
DescribeGroup查看服务群组详情查看服务群组信息。
DescribeSpotDiscountHistory查询抢占式实例历史价格查询抢占式实例历史价格。关于抢占式实例,请参考高级配置:抢占型实例选择。
ListServiceInstances查询服务实例列表获取指定服务的实例列表。
ListServiceVersions查询服务历史版本查询服务历史版本。
ListServiceContainers查询服务的容器列表查询服务的容器列表。
ListServices查询服务列表获取当前用户的服务列表。
ListGroups查看服务组列表列举已创建的服务群组。

资源组

API标题API概述
CreateResource创建资源组创建一个新的资源组。
CreateResourceInstances创建资源组机器在专属资源组中创建新的机器实例。
CreateResourceLog开通资源组日志投递 开通资源组SLS日志投递功能。
DeleteResource删除资源组删除一个已有的资源组,仅当资源组中无任务服务和资源实例的情况下才允许删除。
DeleteResourceDLink关闭资源组VPC直连关闭专属资源组VPC直连功能。
DeleteResourceInstances删除资源组机器实例删除专属资源组中的机器实例,普通用户仅允许删除后付费实例。
DeleteResourceLog关闭资源组日志投递关闭专属资源组SLS日志投递功能。
UpdateResource更新资源组信息更新专属资源组信息。
UpdateResourceDLink更新资源组VPC直连配置更新指定专属资源组的VPC直连配置。
UpdateResourceInstance更新资源组机器实例更新专属资源组机器实例的调度状态。
DescribeResource查看资源组详情查看资源组详情。
DescribeResourceDLink查看资源组VPC直连信息查看专属资源组VPC直连配置详情。
DescribeResourceLog查看资源组日志投递信息查看专属资源组SLS日志投递配置详情。
ListResourceInstances查询资源组机器列表获取指定专属资源组中的机器实例列表。
ListResourceInstanceWorker查询资源组工作实例列表列举资源实例的服务Worker列表。
ListResources查询资源组列表获取当前用户的专属资源组列表。
ListResourceServices查询资源组中的服务列表列举专属资源组中已部署的服务列表。

压测任务

API标题API概述
CreateBenchmarkTask创建压测任务调用CreateBenchmarkTask,创建压测任务。
DeleteBenchmarkTask删除压测任务删除指定的压测任务。
DescribeBenchmarkTask查看压测任务详情查看指定压测任务的详细配置信息。
DescribeBenchmarkTaskReport查看压测任务测试报告查看指定压测任务的报告。
ListBenchmarkTask查询压测任务列表查看当前用户部署的所有压测任务。
StartBenchmarkTask启动压测任务启动指定的压测任务。
StopBenchmarkTask停止压测任务停止指定的压测任务。
UpdateBenchmarkTask更新压测任务更新指定的压测任务。

私有网关

API标题API概述
CreateGateway创建私有网关创建私有网关,目前仅支持在自运维资源组中创建私有网关。
DescribeGateway查看私有网关详情查看私有网关详情。
UpdateGateway更新私有网关更新私有网关。
CreateGatewayIntranetLinkedVpc创建私有网关内网访问端点创建私有网关内网访问端点。
ListGatewayIntranetLinkedVpc查看私有网关内网访问端点列表查看私有网关内网访问端点列表。
DeleteGatewayIntranetLinkedVpc删除私有网关内网访问端点删除私有网关内网访问端点。
DeleteGateway删除私有网关删除私有网关。