文档

QueryTimedResetOperateStatus - 停复机实例开关机状态查询接口

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

查询停复机操作状态接口,提供查询指定的数字人停复机实例(来自虚拟数字人开放平台——实例管理页面)的开关机状态。

接口说明

本接口只能针对数字人停复机实例状态进行查询操作,非停复机实例无法操作。 调用该接口将返回当前停复机实例的开关机状态,具体状态值对应下方的系统返回参数部分。

警告 该接口调用轮询周期建议 3s 一次,不可低于 1s 一次,否则可能会导致触发限流。

调试

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

授权信息

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

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

请求参数

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

租户 ID,从虚拟数字人开放平台中获取的 TenantId

xxxxx
InstanceIdstring

实例 ID

avatar_operation_public_cn-7pp2****802

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

74d42913-f13c-47ac-a8ac-8610685688eb
Codestring

返回结果码

0
Messagestring

返回信息

operation success.
Successboolean

调用接口是否成功

  • false: 调用失败。
  • true:调用成功。
true
Dataobject

返回结果。

InstanceIdstring

实例 id。

avatar_operation_public_cn-7pp2****802
StatusStrstring

当前停复机实例开关机状态中文描述

开机
TenantIdstring

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

xxxxx
Statuslong

当前停复机实例开关机状态枚举值:

  • 10:开机,表示已完成开机,可正常使用
  • 11:开机中,表示正在开机中,不可使用,需等待状态变为开机
  • 20:关机,表示已完成关机,不可使用
  • 21:关机中,表示正在关机中,此时不可使用
10

示例

正常返回示例

JSON格式

{
  "RequestId": "74d42913-f13c-47ac-a8ac-8610685688eb",
  "Code": "0",
  "Message": "operation success.",
  "Success": true,
  "Data": {
    "InstanceId": "avatar_operation_public_cn-7pp2****802\n",
    "StatusStr": "开机",
    "TenantId": "xxxxx",
    "Status": 10
  }
}

错误码

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

  • 本页导读 (0)