停复机操作开机接口,提供对指定的数字人停复机实例(来自虚拟数字人开放平台——实例管理页面)进行开机操作,功能等同于点击页面的开机按钮。

接口说明

请确保在使用该接口前,已充分了解虚拟数字人停复机产品的 收费方式和价格

本接口只能针对数字人停复机实例进行开机操作,非停复机实例无法操作 。调用该接口返回成功,表示系统成功接收到开机请求,此时该停复机实例状态为开机中,系统正在对该实例执行开机操作中, 开机操作正常情况下需要 1-5 分钟时间,如果遇到平台资源池不足可能会需要更长时间 。调用该接口之后可以轮询调用 停复机实例开关机状态查询接口 查询开机执行情况, 轮询周期建议 3s 一次,不可高于 1s 一次,否则可能会导致触发限流

警告 处于开机中状态的实例是无法使用的,需要等待开机完成,状态变化为开机。同时计费将从开机完成之后开始计费。

调试

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

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
TenantId long

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

xxxxxx
InstanceId string

实例 ID。从虚拟数字人开放平台实例管理页面获取。

avatar_operation_public_cn-7pp2****802

返回参数

名称 类型 描述 示例值
object

Schema of Response

RequestId string

请求 ID

13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7
Code string

返回结果码

0
Message string

返回信息。

operation success.
Success boolean

调用接口是否成功

  • false: 调用失败。
  • true:调用成功。
  • true
    Data object

    调用结果数据

    InstanceId string

    实例 id

    avatar_operation_public_cn-7pp2****802
    TenantId long

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

    xxxxxx

    示例

    正常返回示例

    JSON 格式

    {
      "RequestId": "13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7",
      "Code": "0",
      "Message": "operation success.",
      "Success": true,
      "Data": {
        "InstanceId": "avatar_operation_public_cn-7pp2****802",
        "TenantId": 0
    }

    错误码

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

    • 本页导读 (0)