文档

API概览

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

实例管理

API标题API概述
ReserveInstances预定云渲染实例预定云渲染实例。
ReleaseInstances退订云渲染实例退订云渲染实例。
ListInstances查询云渲染实例列表查询云渲染实例列表。

应用管理

API标题API概述
CreateApp创建应用创建一个新的应用。
ModifyApp修改应用信息修改某个应用的名称。
ListApp查询应用列表查询应用列表。
GetApp查询应用详情查询单个应用的详细信息。
DeleteApp删除应用删除某个应用。

版本管理

API标题API概述
CreateAppVersion创建版本为应用创建一个新版本。
ModifyAppVersion修改版本信息修改应用的版本信息。
ListAppVersion查询应用版本列表查询某个应用的版本列表。
GetAppVersion查询版本详情查询某个应用的版本详情。
DeleteAppVersion删除版本删除某个应用的版本。

适配管理

API标题API概述
CreateAdaptation创建适配请求为某个应用版本创建适配请求。
GetAdaptation查询适配详情查询某个适配申请的详情。

容器预定管理

API标题API概述
CreateCapacityReservation创建容器预定任务创建容器预定任务。预定可运行指定会话数量的容器,预定结果通过HTTP接口返回。
CancelReserveTask取消容器预定任务取消指定的容器预定任务。
GetReserveTaskDetail查询容器预定任务详情查询容器预定任务的详细信息。
ReleaseCapacity释放预定的容器释放预定的容器。当符合指定条件且多个条件同时满足时,容器才会被释放。释放结果通过HTTP接口返回。
ReleaseCapacityByBatch根据批次号释放资源释放指定批次的机器。一般是机器预检未通过时,释放指定批次的机器。释放结果通过消息返回。
GetCapacity查询容器信息查询容器信息。

会话管理

API标题API概述
CreateAppSession创建应用会话创建应用会话,并启动一个应用进程,返回会话信息。
StopAppSession停止应用会话停止应用会话,后续停止结果会通过消息返回。
GetAppSession获取应用会话详情获取应用会话详情。
ListAppSessions查询应用会话列表查询应用会话列表,支持批量查询。只支持查询未结束的会话信息。
CreateAppSessionSync同步创建应用会话创建应用会话并启动应用进程后,会话信息通过消息返回。
CreateAppSessionBatchSync批量同步创建应用会话批量创建应用会话,平台会按顺序调配资源,启动多个进程。
StopAppSessionBatch批量停止应用会话批量停止应用会话。后续停止结果会通过HTTP接口返回。
GetAppCcu查询运行中会话统计信息查询运行中会话的详细信息。
BatchCheckSession批量检查疑似异常会话此接口用于检查疑似异常会话。
  • 本页导读 (0)