计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询智能直播间列表

功能介绍

该接口用于智能直播间列表。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/smart-live-rooms

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

每页显示的条目数量。

取值范围:

1-100

默认取值:

10

room_name

String

按直播间名称模糊查询。

dh_id

String

按数字人形象ID查询。

model_name

String

按形象名称模糊查询。

live_state

String

当前直播间直播状态。

WAITING,PROCESSING,SUCCESS,FAILED,CANCELED对应直播任务状态

NULL 对应没有直播任务

可多个状态查询,使用英文逗号分隔。

start_time

String

最近直播任务起始时间。格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。

end_time

String

结束时间。格式遵循:RFC 3339 如"2021-01-10T10:43:17Z"。

room_type

String

按直播间类型查询。直播间类型。

  • NORMAL:普通直播间,直播间一直存在,可以反复开播

  • TEMP:临时直播间,直播任务结束后自动清理直播间。

  • TEMPLATE:直播间模板。

template_own_type

String

按照自己拥有的和别人分享以及公共的模板进行查询

  • OWNED 自己拥有且暂未共享的

  • SHARED_TO_OHTERS 分享给别人的

  • SHARED_FROM_OHTERS 别人分享给我的

  • PUBLIC 公共模板

confirm_state

String

直播间确认状态。此状态仅用于特定用户需要人工确认场景。

  • unconfirm: 未确认

  • confirmed:已确认

  • reject: 拒绝

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息。

X-App-UserId

String

第三方用户ID。不允许输入中文。

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表5 响应Body参数

参数

参数类型

描述

count

Integer

直播间总数。

取值范围:

0-2147483647

smart_live_rooms

Array of SmartLiveRoomBaseInfo objects

直播间列表。

表6 SmartLiveRoomBaseInfo

参数

参数类型

描述

room_id

String

直播间ID

project_id

String

租户id

room_name

String

直播间名称

room_type

String

直播间类型。

  • NORMAL:普通直播间,直播间一直存在,可以反复开播

  • TEMP:临时直播间,直播任务结束后自动清理直播间。

  • TEMPLATE:直播间模板。

默认取值:

NORMAL

room_state

String

直播间配置状态。

  • ENABLE: 直播间正常可用。

  • DISABLE: 直播间不可用。不可用原因在error_info中说明。

  • BLOCKED:直播间被冻结。冻结原因在error_info中说明。

view_mode

String

横竖屏类型。默认值为:VERTICAL。

  • LANDSCAPE:横屏。

  • VERTICAL: 竖屏。

默认取值:

VERTICAL

error_info

ErrorResponse object

数字人直播间出错信息。

shared_config

SharedConfig object

直播间模板分享信息,仅在直播间类型为template的时候不为空

room_description

String

直播间描述。

cover_url

String

直播间封面图URL

thumbnail

String

直播间封面图URL

model_infos

Array of ModelInfo objects

数字人模型信息

create_time

String

创建时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。

update_time

String

更新时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。

last_job_start_time

String

开始直播时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。

last_job_end_time

String

结束直播时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。

last_job_status

String

当前直播状态

  • WAITING:任务等待执行

  • PROCESSING:任务执行中

  • SUCCEED:任务处理成功

  • FAILED:任务处理时变

  • CANCELED:任务取消

  • BLOCKED:任务被冻结

priv_data

String

私有数据,用户填写,原样带回。

confirm_state

String

直播间确认状态。此状态仅用于特定用户需要人工确认场景。

  • UNCONFIRM: 未确认

  • CONFIRMED:已确认

  • REJECT: 拒绝

表7 ErrorResponse

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

表8 SharedConfig

参数

参数类型

描述

shared_type

String

参数解释

共享类型。

约束限制

该配置仅用于模板

取值范围

  • PRIVATE:私有,仅本租户可访问。

  • PUBLIC:公开,所有租户可访问。当前仅提供系统资产可公开访问。

  • SHARED:共享,指定租户可访问。拥有者指定租户可访问。

默认取值

不涉及。

shared_state

String

参数解释

共享状态。

约束限制

该配置仅用于shared_type为SHARED的模板。

取值范围

  • PUBLISHED:发布。模板可用。

  • DRAFT:草稿。编辑态,仅拥有者可访问。

  • REVIEW:审核态。不可编辑,仅拥有者/审核人员可查看。

默认取值

不涉及。

expire_time

String

参数解释

共享过期时间。空表示永久不过期。

约束限制

该配置仅用于shared_type为SHARED的模板。

格式遵循:RFC 3339,示例“20210110T08:43:17Z”。

取值范围

字符长度0-20位

默认取值

不涉及。

allowed_project_ids

Array of strings

参数解释

允许访问本资产的租户列表。

约束限制

该配置仅用于shared_type为SHARED的模板。

取值范围

最大支持100个租户,重复的记录会被忽略。

租户ID填写project_id,字符长度1-64位。

默认取值

不涉及。

表9 ModelInfo

参数

参数类型

描述

model_asset_id

String

模型资产ID,可以从资产库中查询。

asset_name

String

资产名称

backup_model_asset_ids

Array of strings

主播轮换时备选主播数字人资产ID(仅形象资产,不包含音色),可以从资产库中查询。

状态码:400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms

响应示例

状态码:200

成功。

{
  "count" : 1,
  "smart_live_rooms" : [ {
    "room_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66",
    "room_name" : "大自然的传说",
    "room_description" : "课件",
    "create_time" : "2022-11-30T06:59:55Z",
    "update_time" : "2022-12-05T12:30:37Z"
  } ]
}

状态码:400

请求传参异常,包含错误码及对应描述。

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

状态码:401

未鉴权或鉴权失败。

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

状态码:500

内部服务错误。

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

状态码

状态码

描述

200

成功。

400

请求传参异常,包含错误码及对应描述。

401

未鉴权或鉴权失败。

500

内部服务错误。

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容