QueryRunningInstance_虚拟数字人开放平台_API文档-阿里云OpenAPI开发者门户

接口说明

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

流控信息

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

授权信息

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

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

avatar:QueryRunningInstance	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
TenantIdinteger<int64>	从虚拟数字人开放平台中获取的 TenantId 注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:9185
Appobject	代表一个业务配置
SessionIdstring	会话 SessionID，通过“启动一个数字人(StartInstance)”API 的返回值获取。展开详情示例值:76898bd3b90b4a65b1c078d8824a2e9c

返回参数

字段名称	字段详情
RequestIdstring	请求 ID 示例值:13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7
Codestring	返回结果码示例值:0
Messagestring	返回信息示例值:operation success.
Dataarray<object>	返回结果
Successboolean	调用是否成功。示例值:True

返回说明

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

返回示例

变更历史

	变更时间	变更内容概要	操作
	2023-10-30	变更返回参数
	2022-09-21	新增请求参数SessionId
	2022-07-27	新增OpenAPI，查询运行中的数字人实例