ReleaseCapacity_云渲染_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

释放预定容器的操作具有原子性,不存在部分成功或部分失败的情况。

当释放任务成功时,HTTP 接口消息通知如下:

说明 HTTP 接口是接收会话启动、停止、串流等信息的一种方式。目前消息保存 1 天,重试策略为退避策略,最多重试 176 次。

事件类型为RELEASE_CAPACITY_RESULT

注意 不区分模式,仅推送 HTTP 接口。

名称类型是否必选说明
successBoolean任务是否成功。
取值:
true:任务成功。
false:任务失败。
eventTypeString事件类型。
eventDetailObject[EventDetail]事件详情。
当任务成功时,返回该参数。

EventDetail 数据结构如下所示。

名称类型是否必选说明
taskIdString容器异步释放任务 ID。
successBoolean释放是否成功。
取值:
true:释放成功。
false:释放失败。
expectReleaseSessionCapacityInteger期望释放的会话路数。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
cgcs:ReleaseCapacity
Delete
全部资源
*

请求参数

字段名称字段详情
ProjectIdstring

项目 ID。

示例值:d9a8****
AppIdstring

应用 ID。

示例值:13027****参考取值来源:
    ModifyApp
    ListApp
    CreateApp
    GetAppCcu
DistrictIdstring

区域 ID。取值:展开详情

示例值:huadong
ExpectReleaseSessionCapacityinteger<int32>

期望释放的会话路数。

示例值:100
AppVersionstring

版本 ID。

示例值:35067****参考取值来源:
    ListAppVersion
    CreateAppVersion
    ModifyAppVersion
    GetAppSession
    StopAppSession

返回参数

字段名称字段详情
TaskIdstring

容器预定任务 ID。

示例值:b354****
RequestIdstring

请求 ID。

示例值:46329898-489C-4E63-9BA1-C1DA5C5D0986

返回示例

变更历史

变更时间变更内容概要操作
2022-07-19
新增OpenAPI,释放预定的容器

相关示例