实例释放会话 - ReleaseInstancesSession
功能介绍
串流停止后会话还会存续一段时间,此接口可提供释放。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
koophone:cloudphoneResource:releaseInstancesSession
Write
cloudphoneResource *
-
-
-
URI
POST /v1/instances/session/release
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
x-auth-token | 是 | String | 租户的iam token信息 |
x-request-id | 是 | String | 消息跟踪唯一id |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
instance_id | 是 | String | 实例id |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 响应码,错误码规范KooPhone.API.1001,数字递增 |
error_msg | String | 响应描述 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 0:成功 KOOPHONE.API.1000:请求参数错误 KOOPHONE.API.1001:没有实例权限 KOOPHONE.API.9999:服务内部报错 |
error_msg | String | 错误信息 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 0:成功 KOOPHONE.API.1000:请求参数错误 KOOPHONE.API.1001:没有实例权限 KOOPHONE.API.9999:服务内部报错 |
error_msg | String | 错误信息 |
请求示例
/v1/instances/session/release
{
"instance_id" : "iRJEVP96"
} 响应示例
状态码:200
正常响应
{
"error_code" : "0",
"error_msg" : "OK"
} 状态码
状态码 | 描述 |
|---|---|
200 | 正常响应 |
400 | 请求错误 |
500 | 内部错误 |
错误码
请参见错误码。

