API概览 - 人工智能平台 PAI

本产品（弹性算法服务 EAS/2021-07-01）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用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	开发服务	将容器服务转为开发模式，或退出开发模式。
CommitService	Commit容器并发布	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概述
UpdateVirtualResource	更新虚拟资源组信息	更新虚拟资源组信息。
ListVirtualResource	查询虚拟资源组列表	获取当前用户的虚拟资源组列表。
DescribeVirtualResource	查看虚拟资源组详情	查看虚拟资源组详情。
DeleteVirtualResource	删除虚拟资源组	删除一个已有的虚拟资源组，仅当虚拟资源组中无服务任务的情况下才允许删除。
CreateVirtualResource	创建虚拟资源组	创建一个新的虚拟资源组。
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概述
DetachGatewayDomain	解绑网关自定义域名	私有网关解绑自定义域名。
AttachGatewayDomain	绑定网关自定义域名	私有网关绑定自定义域名。
ListGatewayDomains	查询网关自定义域名列表	查询私有网关自定义域名列表。
ListGateway	查询私有网关列表	查询私有网关列表。
ListAclPolicy	查询网关访问权限列表	查看网关访问权限的列表。
DeleteAclPolicy	移除网关访问权限	删除网关的访问权限，删除的IP段不再具备访问网关的权限。
CreateAclPolicy	创建网关访问权限	创建私有网关的访问权限，添加权限的IP段可以访问网关。
CreateGateway	创建私有网关	创建网关。
DescribeGateway	查看私有网关详情	查看私有网关详情。
UpdateGateway	更新私有网关	更新私有网关。
CreateGatewayIntranetLinkedVpc	创建私有网关内网访问端点	创建私有网关内网访问端点。
ListGatewayIntranetLinkedVpc	查看私有网关内网访问端点列表	查看私有网关内网访问端点列表。
DeleteGatewayIntranetLinkedVpc	删除私有网关内网访问端点	删除私有网关内网访问端点。
DeleteGateway	删除私有网关	删除私有网关。

其他

API	标题	API概述
ReinstallTenantAddon	更新租户插件信息	重置租户配置。
ListTenantAddons	查看租户插件列表	查看租户插件列表。
DeleteGatewayIntranetLinkedVpcPeer	删除对等专有网络	删除网关内网访问端点跨VPC连接。
ListGatewayIntranetLinkedVpcPeer	查询对等专有网络列表	获取网关内网访问端点跨VPC连接列表。
CreateGatewayIntranetLinkedVpcPeer	添加对等专有网络	创建网关内网访问端点跨VPC连接。