文档

QueryRunningInstance - 查询运行中的数字人实例

更新时间:

查询运行中的数字人实例列表,该接口仅返回运行中的实例,已关闭的实例不会返回,最多返回100条,按照时间倒序排列;同时支持查询指定sessionId的实例的运行状态,传入sessionId参数,如果该实例在运行中则会返回,不在运行中或者对应实例不存在,则不会返回信息。

接口说明

该接口目前仅会返回最近 100 条运行中的实例(已关闭的不会返回,也不会计入 100 条,按启动时间倒序排序),超出 100 条之外的目前暂不支持返回;同时支持查询指定 sessionId 的实例的运行状态,传入 sessionId 参数,如果该实例在运行中则会返回,不在运行中或者对应实例不存在,则不会返回信息。(SDK 需要升级到 1.0.6 及以上版本)。

调试

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

授权信息

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

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

请求参数

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

从虚拟数字人开放平台中获取的 TenantId

9185
Appobject

代表一个业务配置

AppIdstring

App ID。在业务配置详情页的右下角可以看到开发者信息 AppId

ALIPUB5748B17121450
SessionIdstring

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

  • 传入参数表示查询该 SessionID 对应的实例的运行状态。
  • 不传参数表示查询所有实例的运行状态。
76898bd3b90b4a65b1c078d8824a2e9c

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7
Codestring

返回结果码

0
Messagestring

返回信息

operation success.
Dataobject []

返回结果

SessionIdstring

会话 ID

4f63f9e9788449f9adc88d9438c8dec3
Channelobject

频道信息(同“启动一个数字人(StartInstance)”API 返回的 Channel 信息)

ChannelIdstring

频道 ID

108293819
Tokenstring

令牌码。

e59f61b2482b4d0562ab542da3f824f7
Typestring

通道类型

6
ExpiredTimestring

通道到期时间

2022-01-04T16:00Z
Noncestring

服务器生成的随机字符串。

CK-9b5c335b9ae75879441ee7b363886418
UserIdstring

音视频 RTC 生成的 UserId

userId
AppIdstring

用于 RTC 的应用 id

ONEX7E28C7C221854
UserInfoInChannelstring

公有云音视频 RTC 需要的信息

公有云音视频RTC需要的信息
Gslbarray

通道设置。

string

通道设置。

djfls
Userobject

“启动一个数字人(StartInstance)”API 传入的 User 信息,此处会将对应 User 返回

UserIdstring

用户身份 ID(启动一个数字人 API 传入的 User.UserId)

23423
UserNamestring

用户名(启动一个数字人 API 传入的 User.UserName)

测试用户
Tokenstring

互动数字人对接需要的鉴权 token ,具体可参考互动数字人接入文档

879441ee7b363886418
Successboolean

调用是否成功。

True

针对传入 sessionId 参数的情况下,如果该接口没有返回对应的 Data,则表示该 sessionId 对应的实例不在运行中,或者 sessionId 对应的实例不存在

示例

正常返回示例

JSON格式

{
  "RequestId": "13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\n",
  "Code": "0",
  "Message": "operation success.",
  "Data": [
    {
      "SessionId": "4f63f9e9788449f9adc88d9438c8dec3",
      "Channel": {
        "ChannelId": "108293819",
        "Token": "e59f61b2482b4d0562ab542da3f824f7",
        "Type": "6",
        "ExpiredTime": "2022-01-04T16:00Z",
        "Nonce": "CK-9b5c335b9ae75879441ee7b363886418",
        "UserId": "userId",
        "AppId": "ONEX7E28C7C221854",
        "UserInfoInChannel": "公有云音视频RTC需要的信息",
        "Gslb": [
          "djfls"
        ]
      },
      "User": {
        "UserId": "23423",
        "UserName": "测试用户"
      },
      "Token": "879441ee7b363886418"
    }
  ],
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-10-30OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-09-21OpenAPI 描述信息更新、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
入参OpenAPI 入参发生变更
    新增入参:SessionId
2022-07-27新增 OpenAPI看变更集
  • 本页导读 (0)