云渲染产品的开发调用对接-云渲染-阿里云-云渲染（文档停止维护）(GCS)-阿里云帮助中心

API标准及多语言预置SDK

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

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

实例管理

API	标题	API概述
ReserveInstances	预定云渲染实例	预定GCS实例
ReleaseInstances	退订云渲染实例	退订云渲染实例。
ListInstances	查询云渲染实例列表	查询云渲染实例列表。
DescribeInstanceStatsInfo	查询实例统计	此 API 旨在查询不同维度下，用户购买的云渲染实例统计信息。用户可以通过此接口获取项目（ProjectId）、大区（DistrictId）和实例类型（InstanceType）等条件下的实例统计信息，实例统计信息中包含: 创建中、运行中、运维中、释放中等状态的实例数量。

应用管理

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	批量检查疑似异常会话	此接口用于检查疑似异常会话。