文档

StopInstance - 停止一个数字人

更新时间:

关闭一路数字人实例,停止数字人推流。

接口说明

二方包引入可参考 API 概览的信息

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
avatar:StopInstanceWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TenantIdlong

从虚拟数字人开放平台的对应业务配置的开发者信息中获取的 TenantId

234234
SessionIdstring

会话 SessionID。通过“启动一个数字人”API 的返回值获取。

9adb569b-f66b-4e92-8b9d-62aa626f8318

返回参数

名称类型描述示例值
object

响应结果

Codestring

响应码

0
Messagestring

响应信息

错误信息示例
Dataobject

返回结果。

RequestIdstring

请求 ID

4C467B38-3910-447D-87BC-AC049166F216
SessionIdstring

会话 ID。

6296cc143d2c42899dae6eff19e8ac28
Successboolean

调用是否成功。

True

示例

正常返回示例

JSON格式

{
  "Code": "0",
  "Message": "错误信息示例",
  "Data": {
    "RequestId": " 4C467B38-3910-447D-87BC-AC049166F216",
    "SessionId": "6296cc143d2c42899dae6eff19e8ac28"
  },
  "Success": true
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)