CloseTimedResetOperate
停复机操作关机接口,提供对指定的数字人停复机实例(来自虚拟数字人开放平台——实例管理页面)进行关机操作,功能等同于点击页面的关机按钮
服务地址:
华北3(张家口)
输入参数
只看必填
TenantId租户ID
InstanceId实例ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

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

请求参数

字段名称字段详情
TenantIdinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:xxxxx
InstanceIdstring

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

示例值:avatar_operation_public_cn-7pp2****802

返回参数

字段名称字段详情
RequestIdstring

Id of the request

示例值:4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX
Codestring

返回结果码

示例值:0
Messagestring

返回信息

示例值:operation success.
Successboolean

调用接口是否成功展开详情

示例值:true
Dataobject

调用结果数据

变更历史
暂无变更历史