文档

CloseTimedResetOperate - 停复机操作关机接口

更新时间:
重要

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

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

接口说明

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

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

警告 调用关机接口之后该实例将立即无法使用,同时也将停止计费,如果需要重新使用请在关机完成之后调用开机操作,重新开机使用。

调试

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

授权信息

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

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

请求参数

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

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

xxxxx
InstanceIdstring

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

avatar_operation_public_cn-7pp2****802

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX
Codestring

返回结果码

0
Messagestring

返回信息

operation success.
Successboolean

调用接口是否成功

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

调用结果数据

InstanceIdstring

实例 ID

avatar_operation_public_cn-7pp2****802
TenantIdlong

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

xxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX",
  "Code": "0",
  "Message": "operation success.",
  "Success": true,
  "Data": {
    "InstanceId": "avatar_operation_public_cn-7pp2****802\n",
    "TenantId": 0
  }
}

错误码

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

  • 本页导读 (0)