华为云用户手册

  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求ID。 表5 响应Body参数 参数 参数类型 描述 count Integer 直播间总数。 smart_live_rooms Array of SmartLiveRoomBaseInfo objects 直播间列表。 表6 SmartLiveRoomBaseInfo 参数 参数类型 描述 room_id String 直播间ID room_name String 直播间名称 room_type String 直播间类型。 NORMAL: 普通直播间,直播间一直存在,可以反复开播 TEMP: 临时直播间,直播任务结束后自动清理直播间。 TEMPLATE: 直播间模板。 room_state String 直播间配置状态。 ENABLE: 直播间正常可用。 DISABLE: 直播间不可用。不可用原因在error_info中说明。 BLOCKED:直播间被冻结。冻结原因在error_info中说明。 error_info ErrorResponse object 数字人直播间出错信息。 room_description String 直播间描述。 cover_url 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:任务取消 表7 ErrorResponse 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 表8 ModelInfo 参数 参数类型 描述 model_asset_id String 模型资产ID asset_name String 资产名称 backup_model_asset_ids Array of strings 主播轮换时备选主播数字人资产ID(仅形象资产,不包含音色)。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 请求参数 表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。 说明: *不允许输入中文。
  • URI GET /v1/{project_id}/smart-live-rooms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询。 limit 否 Integer 每页显示的条目数量。 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: 直播间模板。
  • 请求参数 表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-App-UserId 否 String 第三方用户ID。 说明: *不允许输入中文。
  • 响应示例 状态码: 200 处理成功返回。 { "count" : 101, "jobs" : [ { "job_id" : "646682facddb4912976f19a4d61c6a91", "name" : "名字1", "state" : "TRAINING", "project_id" : "***", "cover_download_url" : "https://xxx.com/646682facddb4912976f19a4d61c6a91_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-09T07:38:09Z", "create_time" : "2023-12-08T08:30:56Z", "contact" : "1**********", "tags" : [ ], "model_version" : "V3.2", "matting_type" : "AI" }, { "job_id" : "efc5300ecdba4ea48d1ff13a9d907bc0", "name" : "名字2", "state" : "MANUAL_VERIFYING", "project_id" : "***", "cover_download_url" : "https://xxx.com/efc5300ecdba4ea48d1ff13a9d907bc0_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-09T07:32:46Z", "create_time" : "2023-12-09T07:31:37Z", "contact" : "1**********", "model_version" : "V3", "matting_type" : "AI" }, { "job_id" : "7889dfd55bf14834a35e78c7f0aa0516", "name" : "名字3", "state" : "INFERENCE_DATA_PREPROCESS_FAILED", "project_id" : "***", "cover_download_url" : "https://xxx.com/7889dfd55bf14834a35e78c7f0aa0516_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-09T07:09:02Z", "create_time" : "2023-12-08T08:34:12Z", "contact" : "1**********", "tags" : [ ], "model_version" : "V3.2", "matting_type" : "AI" }, { "job_id" : "222509ed63c2498599f519d5ec7ef462", "name" : "名字4", "state" : "TRAINING_DATA_PREPROCESS_SUCCESS", "project_id" : "***", "cover_download_url" : "https://xxx.com/222509ed63c2498599f519d5ec7ef462_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-09T07:08:21Z", "create_time" : "2023-12-08T08:33:24Z", "contact" : "1**********", "tags" : [ ], "model_version" : "V3.2", "matting_type" : "AI" }, { "job_id" : "dd4a596edc2c44dd881b5e9eff485e21", "name" : "名字5", "state" : "TRAINING_DATA_PREPROCESS_SUCCESS", "project_id" : "***", "cover_download_url" : "https://xxx.com/dd4a596edc2c44dd881b5e9eff485e21_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-09T02:12:01Z", "create_time" : "2023-12-08T08:29:25Z", "contact" : "1**********", "model_version" : "V3.2", "matting_type" : "AI" }, { "job_id" : "bf46c9f335b14e84bd028f6acb52686b", "name" : "名字6", "state" : "JOB_FINISH", "asset_id" : "3174263c6199e0a10d83a257b272ac71", "project_id" : "***", "cover_download_url" : "https://xxx.com/bf46c9f335b14e84bd028f6acb52686b_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-08T08:37:39Z", "create_time" : "2023-11-29T09:39:25Z", "contact" : "1**********", "model_version" : "V3", "matting_type" : "AI" }, { "job_id" : "2f96ddd4fdda40af977c1b1d3b6adca8", "name" : "名字7", "state" : "INFERENCE_DATA_PREPROCESS_FAILED", "asset_id" : "22741ee4bc4130282835bdc2a4b4ac79", "project_id" : "***", "cover_download_url" : "https://xxx.com/2f96ddd4fdda40af977c1b1d3b6adca8_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-08T07:26:53Z", "create_time" : "2023-10-19T01:13:24Z", "contact" : "15312090046", "batch_name" : "234", "model_version" : "V3", "matting_type" : "AI" }, { "job_id" : "e477dcf363234b2f8aa2aad4d8bad46b", "name" : "名字8", "state" : "INFERENCE_DATA_PREPROCESS_FAILED", "asset_id" : "d36e8df774ae88315911724d4467cb6d", "project_id" : "***", "cover_download_url" : "https://xxx.com/e477dcf363234b2f8aa2aad4d8bad46b_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-08T01:58:52Z", "create_time" : "2023-11-27T06:39:46Z", "contact" : "1**********", "model_version" : "V3.2", "matting_type" : "AI" }, { "job_id" : "d8ca20175d5b4ae6b0056c62e4553d36", "name" : "名字9", "state" : "INFERENCE_DATA_PREPROCESS_FAILED", "asset_id" : "5ff8e2893ffa8ef848050260eb08faa9", "project_id" : "***", "cover_download_url" : "https://xxx.com/d8ca20175d5b4ae6b0056c62e4553d36_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-04T05:39:24Z", "create_time" : "2023-11-06T13:51:09Z", "contact" : "1**********", "model_version" : "V3.2", "matting_type" : "AI" }, { "job_id" : "65e9fb9ac78546268e7d60d5003bfbdc", "name" : "名字10", "state" : "INFERENCE_DATA_PREPROCESS_FAILED", "asset_id" : "71a0df4bd5966a33818af2b5094cf197", "project_id" : "***", "cover_download_url" : "https://xxx.com/65e9fb9ac78546268e7d60d5003bfbdc_cover?param1=XXX¶m2=YYY", "last_update_time" : "2023-12-01T07:58:26Z", "create_time" : "2023-11-29T11:19:22Z", "contact" : "1**********", "model_version" : "V3", "matting_type" : "AI" } ] } 状态码: 400 { "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" } 状态码: 500 { "error_code" : "MSS.00000004", "error_msg" : "Internal Error" }
  • 请求参数 表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 分身数字人模型训练任务数量。 jobs Array of TrainingJobBasicInfo objects 分身数字人模型训练任务列表。 表6 TrainingJobBasicInfo 参数 参数类型 描述 job_id String 任务ID。 name String 分身数字人模型名称。该名称会作为资产库中分身数字人模型资产名称。 state String 任务的状态。 WAIT_FILE_UPLOAD: 待上传文件 AUTO_VERIFYING: 自动审核中 AUTO_VERIFY_FAILED: 自动审核失败 MANUAL_VERIFYING: 人工审核中 MANUAL_VERIFY_FAILED: 人工审核失败 MANUAL_VERIFY_SUCCESS: 审核通过,等待预处理资源 TRAINING_DATA_PREPROCESSING:训练数据预处理中 TRAINING_DATA_PREPROCESS_FAILED: 训练数据预处理失败 TRAINING_DATA_PREPROCESS_SUCCESS: 训练数据预处理完成,等待训练资源中 TRAINING: 训练中 TRAIN_FAILED: 训练失败 TRAIN_SUCCESS: 训练完成,等待预处理资源 INFERENCE_DATA_PREPROCESSING: 推理数据预处理中 INFERENCE_DATA_PREPROCESS_FAILED: 推理数据预处理失败 WAIT_MAIN_FILE_UPLOAD:等待主文件上传 JOB_SUCCESS: 完成 WAIT_USER_CONFIRM:等待用户确认训练效果 JOB_REJECT:驳回 JOB_PENDING:挂起 JOB_FINISH:结束,最终状态,不可再做改变 asset_id String 模型资产ID。 project_id String 模型资产所属项目ID。 cover_download_url String 分身数字人模型封面下载URL。URL有效期24小时。 last_update_time String 用户最近一次更新任务的时间(包括租户创建或者重新提交),格式遵循:RFC 3339。 例 “2020-07-30T10:43:17Z” create_time String 创建时间,格式遵循:RFC 3339。 例 “2020-07-30T10:43:17Z” contact String 分身数字人训练任务创建者联系方式,如手机或邮箱等。 batch_name String 分身数字人训练任务的批次名称。 tags Array of strings 分身数字人训练任务标签。 model_version String 分身数字人模型版本。默认是V3版本模型。 V2: V2版本模型 V3:V3版本模型 matting_type String 抠图类型。默认是AI。 AI:AI抠图 MANUAL:人工抠图 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 约束与限制 华为云MetaStudio服务设置了API流量控制,避免出现短时间内重复调用API,服务中断的情况。API流控限制说明如表1所示。 表1 API流控限制 接口分类 接口名称 单租户接口流控 接口总体流控 数字资产管理 创建资产 1次/秒 10次/秒 更新资产 1次/秒 10次/秒 删除资产 2次/秒 20次/秒 查询资产列表 20次/秒 200次/秒 查询资产详情 10次/秒 100次/秒 恢复被删除的资产 1次/秒 10次/秒 查询资产概要 20次/秒 200次/秒 文件管理 创建文件并获取上传URL 1次/秒 10次/秒 删除文件 1次/秒 10次/秒 确认文件已上传 1次/秒 10次/秒 数字人风格管理 查询数字人风格列表 10次/秒 100次/秒 风格化照片建模 创建照片建模任务 1次/秒 10次/秒 照片建模任务列表查询 1次/秒 10次/秒 照片建模任务详情查询 1次/秒 10次/秒 基于图片URL创建照片建模任务 2次/秒 10次/秒 语音驱动 创建语音驱动任务 1次/秒 10次/秒 获取语音驱动任务列表 20次/秒 200次/秒 获取语音驱动数据 20次/秒 200次/秒 视频驱动 创建视频驱动任务 1次/秒 10次/秒 查询视频驱动任务列表 20次/秒 200次/秒 查询视频驱动任务详情 20次/秒 200次/秒 停止视频驱动任务 1次/秒 10次/秒 控制数字人驱动 1次/秒 10次/秒 视频制作剧本管理 创建视频制作剧本 1次/秒 10次/秒 查询视频制作剧本列表 20次/秒 200次/秒 查询视频制作剧本详情 20次/秒 200次/秒 更新视频制作剧本 1次/秒 10次/秒 删除视频制作剧本 2次/秒 20次/秒 分身数字人视频制作管理 创建分身数字人视频制作任务 1次/秒 10次/秒 查询分身数字人视频制作任务详情 20次/秒 200次/秒 取消等待中的分身数字人视频制作任务 1次/秒 10次/秒 创建照片分身数字人视频制作任务 1次/秒 10次/秒 查询照片分身数字人视频制作任务详情 20次/秒 200次/秒 取消等待中的照片分身数字人视频制作任务 1次/秒 10次/秒 数字人名片制作管理 创建数字人名片制作 1次/秒 10次/秒 查询数字人名片制作任务列表 20次/秒 200次/秒 查询数字人名片制作任务详情 20次/秒 200次/秒 更新数字人名片制作 1次/秒 10次/秒 删除数字人名片制作任务 2次/秒 20次/秒 智能直播间管理 创建智能直播间 1次/秒 10次/秒 查询智能直播间列表 20次/秒 200次/秒 查询智能直播剧本详情 20次/秒 200次/秒 更新智能直播间信息 1次/秒 10次/秒 删除智能直播间 2次/秒 20次/秒 直播任务管理 启动数字人智能直播任务 1次/秒 10次/秒 查询数字人智能直播任务列表 20次/秒 200次/秒 查询数字人智能直播任务详情 20次/秒 200次/秒 结束数字人智能直播任务 1次/秒 10次/秒 控制数字人直播过程 1次/秒 10次/秒 上报直播间事件 1次/秒 10次/秒 父主题: 使用前必读
  • 请求参数 表2 请求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 成功。 { "room_id" : "24bad716-87b1-45e5-8912-6102f7693265", "room_name" : "大自然的传说", "room_description" : "课件", "scene_scripts" : [ { "script_name" : "大自然的传说 一", "model_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a", "voice_config" : { "voice_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a" }, "background_config" : [ { "background_type" : "IMAGE", "background_config" : "978f893e1de4553c183b7a805e6290f5" } ], "shoot_scripts" : [ { "sequence_no" : 1, "text_config" : { "text" : "大家好,我是云笙" } } ] } ] } 状态码: 400 { "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" } 状态码: 401 { "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" } 状态码: 404 { "error_code" : "MSS.00000002", "error_msg" : "Not Found" } 状态码: 500 { "error_code" : "MSS.00000004", "error_msg" : "Internal Error" }
  • 响应示例 状态码: 200 成功。 { "count" : 1, "video_scripts" : [ { "script_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66", "script_name" : "大自然的传说", "model_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a", "script_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" }
  • URI GET /v1/{project_id}/digital-human-video-scripts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询。 limit 否 Integer 每页显示的条目数量。 name 否 String 按名称模糊查询。 script_catalog 否 String 剧本类型。默认查询VIDEO_DRAFT。 VIDEO_DRAFT:视频草稿。 SYSTEM_VIDEO_TEMPLET: 系统视频模板。 view_mode 否 String 横竖屏类型(内部参数,不对外开放)。默认值是LANDSCAPE。 LANDSCAPE:横屏。 VERTICAL: 竖屏。
  • 请求参数 表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 剧本总数。 video_scripts Array of VideoScriptBaseInfo objects 剧本列表。 表6 VideoScriptBaseInfo 参数 参数类型 描述 script_id String 剧本ID。 script_name String 剧本名称。 script_description String 剧本描述。 model_asset_id String 数字人模型资产ID。 model_asset_type String 数字人模型类型。 HUMAN_MODEL_2D:分身数字人 HUMAN_MODEL_3D:3D数字人 script_cover_url String 剧本封面下载url。 script_type String 脚本类型,即视频制作的驱动方式。默认TEXT TEXT: 文本驱动,即通过TTS合成语音 AUDIO: 语音驱动 text String 台词脚本。 create_time String 创建时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 update_time String 更新时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应参数 状态码: 200 表15 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求ID。 表16 响应Body参数 参数 参数类型 描述 group_id String 互动规则库ID 状态码: 400 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 401 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表19 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 成功。 { "group_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66" } 状态码: 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" }
  • 请求参数 表2 请求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。 说明: *不允许输入中文。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 互动规则库名称 interaction_rules 否 Array of InteractionRuleInfo objects 互动规则列表 表4 InteractionRuleInfo 参数 是否必选 参数类型 描述 rule_index 否 String 规则索引 rule_name 否 String 规则名称 enabled 否 Boolean 是否启用 event_type 否 Integer 事件类型。 * 1:弹幕事件 * 2:用户入场事件 * 3:用户点赞事件 * 4:用户送礼事件 * 10: 预置话术事件 hit_condition 否 HitCondition object 命中条件 trigger 否 TriggerProcess object 触发器 review_config 否 ReviewConfig object 内容审核配置 表5 HitCondition 参数 是否必选 参数类型 描述 relation 否 String 条件关系;取值And或者Or priority 否 Integer 优先级,数值越低优先级越高;取值0-999,默认值为500,为可选值 tags 否 Array of HitConditionTag objects 匹配关系配置 表6 HitConditionTag 参数 是否必选 参数类型 描述 tag 否 String 事件内容关键字段 operation 否 String 字段处理 SUM: 累计 AVG:平均 COUNT: 计数 NONE: 无处理 match 否 String 匹配类型 EQUAL: 完全相等 REGEX:正则匹配 MATH_GT:数值大于 MATH_GE: 数值大于等于 MATH_LT:数值小于 MATH_LE:数值小于等于 MATH_EQ:数值相等 value 否 String 匹配值 表7 TriggerProcess 参数 是否必选 参数类型 描述 time_window 否 Integer 处理抑制时长。单位秒。 -1 表示整场直播 0 表示无抑制,每次都触发 reply_mode 否 String 回复类型。 SYSTEM_REPLY:系统自动回复设置的话术。 CALLBACK:回调给其他服务,携带设置的话术。 SHOW_LAYER: 显示叠加图层,不影响话术。 layer_config 否 SmartLayerConfig object 智能图层配置。 reply_texts 否 Array of strings 回复话术集 reply_audios 否 Array of ReplyAudioInfo objects 回复音频集。填写audio_url。 reply_order 否 String 回复次序 RANDOM:随机 ORDER:顺序循环 表8 SmartLayerConfig 参数 是否必选 参数类型 描述 layer_type 是 String 图层类型。 IMAGE: 素材图片图层 VIDEO: 素材视频图层 position 是 LayerPositionConfig object 图层位置配置。 size 否 LayerSizeConfig object 图层大小配置。 image_config 否 SmartImageLayerConfig object 素材图片图层配置。 video_config 否 SmartVideoLayerConfig object 素材视频图层配置。 表9 LayerPositionConfig 参数 是否必选 参数类型 描述 dx 是 Integer 图层左上角像素点的X轴位置值(画布左上角坐标是0x0)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 dy 是 Integer 图层图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 layer_index 是 Integer 图片/视频/人物图的层顺序。 说明: 图层顺序从1开始的整数,底层图层顺序是1,往上依次增加。 表10 LayerSizeConfig 参数 是否必选 参数类型 描述 width 否 Integer 图层图片宽度像素值(相对画布大小)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 height 否 Integer 图层图片高度像素值(相对画布大小)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 表11 SmartImageLayerConfig 参数 是否必选 参数类型 描述 image_url 是 String 图片文件的URL。 display_duration 否 Integer 图片显示时长。单位s 0表示一直显示。 表12 SmartVideoLayerConfig 参数 是否必选 参数类型 描述 video_url 是 String 视频文件的URL。 video_cover_url 否 String 视频封面文件的URL。 display_duration 否 Integer 视频显示时长。单位s 0:表示一直显示。 表13 ReplyAudioInfo 参数 是否必选 参数类型 描述 audio_url 否 String 音频URL audio_name 否 String 音频名 表14 ReviewConfig 参数 是否必选 参数类型 描述 no_need_review 否 Boolean 免审核。 目前仅白名单用户可使用此参数,非白名单用户跟随系统策略审核。
  • 请求示例 POST https://metastudio.cn-east-3.myhuaweicloud.com/v1/6a6a1f8354f64dd9b9a614def7b59d83/digital-assets { "asset_name" : "云笙模型", "asset_description" : "华为云数字人员工", "asset_type" : "HUMAN_MODEL", "tags" : [ "数字人员工" ] }
  • 功能介绍 该接口用于在资产库中添加上传新的媒体资产。可上传的资产类型包括:分身数字人模型、背景图片、素材图片、素材视频、PPT等。 资产类型是IMAGE时,通过system_properties来区分背景图片(BACKGROUND_IMG)、素材图片(MATERIAL_IMG)。 资产类型是VIDEO时,通过system_properties来区分素材视频(MATERIAL_VIDEO)、名片视频(BUSSINESS_CARD_VIDEO)。 MetaStudio平台生成的视频,system_properties带CREATED_BY_PLATFORM。
  • 操作步骤 获取用户Token,用于调用MetaStudio接口时进行认证鉴权。 在“我的凭证”页面获取username、password、domainname,调用如下接口获取Token。详细信息请参见构造请求。 POST https://iam.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //用户名。 "password": "password", //用户登录密码。 "domain": { "name": "domainname" //用户所属的账号名。 } } } }, "scope": { "project": { "name": "cn-east-3" //用户所属region,如cn-east-3。 } } } } 如图1所示,红框中的信息为获取用户Token。 图1 获取用户Token 调用启动视觉驱动接口,获取视觉驱动任务。 选择POST请求方法并输入URI。 https://metastudio.cn-east-3.myhuaweicloud.com/v1/{project_id}/video-motion-capture-jobs 请求消息头中增加“X-Auth-Token”,值设置为步骤1中获取的用户Token。 Request Body中传入驱动模式和驱动数据输出地址及会话ID,如下: { "motion_capture_mode": "AUTO", "output_info": { "body_addr": "100.85.133.90:30001", "face_addr": "100.85.133.90:30002", "session_id": 3223 } } 请求响应成功后,返回JobID和视频传输使用的RTC房间信息。 { "job_id": "e9def8d3262d434eb9c8f07631c265f6", "rtc_room_info": { "app_id": "cbu_hmac", "room_id": "e9def8d3262d434eb9c8f07631c265f6", "users": [{ "ctime": 1670402765, "signature": "d6ab5885978cb2a5f0ee4454eb0bcacdb67eb9eba306ff3072bab1b8d62bf2dd", "user_id": "e9def8d3262d434eb9c8f07631c265f6_capture", "user_type": "CAPTURE" } ] } } 采集视频驱动数字人。 您可以使用SparkRTC SDK或者自行构造符合SparkRTC协议端侧工具基于上述任务返回的房间信息,使用CAPTURE类型用户信息加入房间,采集视频驱动数字人。驱动数据会通过QUIC发送至配置的目标地址。 调用停止视觉驱动接口,停止视觉驱动任务。 选择POST请求方法并输入URI,其中job_id为创建任务时返回的job_id。 https://metastudio.cn-east-3.myhuaweicloud.com/v1/{project_id}/video-motion-capture-jobs/{job_id}/finish 请求消息头中增加“X-Auth-Token”,值设置为步骤1中获取的用户Token。 Request Body中无需其他参数。 请求响应成功后,停止视觉驱动任务。
  • 响应示例 状态码: 200 成功。 { "group_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66" } 状态码: 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 表15 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求ID。 表16 响应Body参数 参数 参数类型 描述 group_id String 互动规则库ID group_name String 互动规则库名称 interaction_rules Array of InteractionRuleDetailInfo objects 互动规则列表 create_time String 创建时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 update_time String 更新时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 表17 InteractionRuleDetailInfo 参数 参数类型 描述 rule_index String 规则索引 rule_name String 规则名称 enabled Boolean 是否启用 event_type Integer 事件类型。 * 1:弹幕事件 * 2:用户入场事件 * 3:用户点赞事件 * 4:用户送礼事件 * 10: 预置话术事件 hit_condition HitCondition object 命中条件 trigger TriggerProcess object 触发器 review_config ReviewConfig object 内容审核配置 rule_id String 互动规则ID create_time String 创建时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 update_time String 更新时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 表18 HitCondition 参数 参数类型 描述 relation String 条件关系;取值And或者Or priority Integer 优先级,数值越低优先级越高;取值0-999,默认值为500,为可选值 tags Array of HitConditionTag objects 匹配关系配置 表19 HitConditionTag 参数 参数类型 描述 tag String 事件内容关键字段 operation String 字段处理 SUM: 累计 AVG:平均 COUNT: 计数 NONE: 无处理 match String 匹配类型 EQUAL: 完全相等 REGEX:正则匹配 MATH_GT:数值大于 MATH_GE: 数值大于等于 MATH_LT:数值小于 MATH_LE:数值小于等于 MATH_EQ:数值相等 value String 匹配值 表20 TriggerProcess 参数 参数类型 描述 time_window Integer 处理抑制时长。单位秒。 -1 表示整场直播 0 表示无抑制,每次都触发 reply_mode String 回复类型。 SYSTEM_REPLY:系统自动回复设置的话术。 CALLBACK:回调给其他服务,携带设置的话术。 SHOW_LAYER: 显示叠加图层,不影响话术。 layer_config SmartLayerConfig object 智能图层配置。 reply_texts Array of strings 回复话术集 reply_audios Array of ReplyAudioInfo objects 回复音频集。填写audio_url。 reply_order String 回复次序 RANDOM:随机 ORDER:顺序循环 表21 SmartLayerConfig 参数 参数类型 描述 layer_type String 图层类型。 IMAGE: 素材图片图层 VIDEO: 素材视频图层 position LayerPositionConfig object 图层位置配置。 size LayerSizeConfig object 图层大小配置。 image_config SmartImageLayerConfig object 素材图片图层配置。 video_config SmartVideoLayerConfig object 素材视频图层配置。 表22 LayerPositionConfig 参数 参数类型 描述 dx Integer 图层左上角像素点的X轴位置值(画布左上角坐标是0x0)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 dy Integer 图层图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 layer_index Integer 图片/视频/人物图的层顺序。 说明: 图层顺序从1开始的整数,底层图层顺序是1,往上依次增加。 表23 LayerSizeConfig 参数 参数类型 描述 width Integer 图层图片宽度像素值(相对画布大小)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 height Integer 图层图片高度像素值(相对画布大小)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 表24 SmartImageLayerConfig 参数 参数类型 描述 image_url String 图片文件的URL。 display_duration Integer 图片显示时长。单位s 0表示一直显示。 表25 SmartVideoLayerConfig 参数 参数类型 描述 video_url String 视频文件的URL。 video_cover_url String 视频封面文件的URL。 display_duration Integer 视频显示时长。单位s 0:表示一直显示。 表26 ReplyAudioInfo 参数 参数类型 描述 audio_url String 音频URL audio_name String 音频名 表27 ReviewConfig 参数 参数类型 描述 no_need_review Boolean 免审核。 目前仅白名单用户可使用此参数,非白名单用户跟随系统策略审核。 状态码: 400 表28 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 401 表29 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表30 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 请求参数 表2 请求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。 说明: *不允许输入中文。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 互动规则库名称 interaction_rules 否 Array of InteractionRuleInfo objects 互动规则列表 表4 InteractionRuleInfo 参数 是否必选 参数类型 描述 rule_index 否 String 规则索引 rule_name 否 String 规则名称 enabled 否 Boolean 是否启用 event_type 否 Integer 事件类型。 * 1:弹幕事件 * 2:用户入场事件 * 3:用户点赞事件 * 4:用户送礼事件 * 10: 预置话术事件 hit_condition 否 HitCondition object 命中条件 trigger 否 TriggerProcess object 触发器 review_config 否 ReviewConfig object 内容审核配置 表5 HitCondition 参数 是否必选 参数类型 描述 relation 否 String 条件关系;取值And或者Or priority 否 Integer 优先级,数值越低优先级越高;取值0-999,默认值为500,为可选值 tags 否 Array of HitConditionTag objects 匹配关系配置 表6 HitConditionTag 参数 是否必选 参数类型 描述 tag 否 String 事件内容关键字段 operation 否 String 字段处理 SUM: 累计 AVG:平均 COUNT: 计数 NONE: 无处理 match 否 String 匹配类型 EQUAL: 完全相等 REGEX:正则匹配 MATH_GT:数值大于 MATH_GE: 数值大于等于 MATH_LT:数值小于 MATH_LE:数值小于等于 MATH_EQ:数值相等 value 否 String 匹配值 表7 TriggerProcess 参数 是否必选 参数类型 描述 time_window 否 Integer 处理抑制时长。单位秒。 -1 表示整场直播 0 表示无抑制,每次都触发 reply_mode 否 String 回复类型。 SYSTEM_REPLY:系统自动回复设置的话术。 CALLBACK:回调给其他服务,携带设置的话术。 SHOW_LAYER: 显示叠加图层,不影响话术。 layer_config 否 SmartLayerConfig object 智能图层配置。 reply_texts 否 Array of strings 回复话术集 reply_audios 否 Array of ReplyAudioInfo objects 回复音频集。填写audio_url。 reply_order 否 String 回复次序 RANDOM:随机 ORDER:顺序循环 表8 SmartLayerConfig 参数 是否必选 参数类型 描述 layer_type 是 String 图层类型。 IMAGE: 素材图片图层 VIDEO: 素材视频图层 position 是 LayerPositionConfig object 图层位置配置。 size 否 LayerSizeConfig object 图层大小配置。 image_config 否 SmartImageLayerConfig object 素材图片图层配置。 video_config 否 SmartVideoLayerConfig object 素材视频图层配置。 表9 LayerPositionConfig 参数 是否必选 参数类型 描述 dx 是 Integer 图层左上角像素点的X轴位置值(画布左上角坐标是0x0)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 dy 是 Integer 图层图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 layer_index 是 Integer 图片/视频/人物图的层顺序。 说明: 图层顺序从1开始的整数,底层图层顺序是1,往上依次增加。 表10 LayerSizeConfig 参数 是否必选 参数类型 描述 width 否 Integer 图层图片宽度像素值(相对画布大小)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 height 否 Integer 图层图片高度像素值(相对画布大小)。 说明: 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 表11 SmartImageLayerConfig 参数 是否必选 参数类型 描述 image_url 是 String 图片文件的URL。 display_duration 否 Integer 图片显示时长。单位s 0表示一直显示。 表12 SmartVideoLayerConfig 参数 是否必选 参数类型 描述 video_url 是 String 视频文件的URL。 video_cover_url 否 String 视频封面文件的URL。 display_duration 否 Integer 视频显示时长。单位s 0:表示一直显示。 表13 ReplyAudioInfo 参数 是否必选 参数类型 描述 audio_url 否 String 音频URL audio_name 否 String 音频名 表14 ReviewConfig 参数 是否必选 参数类型 描述 no_need_review 否 Boolean 免审核。 目前仅白名单用户可使用此参数,非白名单用户跟随系统策略审核。
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求ID。 表5 响应Body参数 参数 参数类型 描述 file_id String 文件ID。 upload_url String 文件上传地址,有效期为24小时。 说明: 调用OBS的"PUT上传"接口上传文件。 调用上述接口时,Content-MD5头必须填写,填写的值跟file_md5中的值相同。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 请求参数 表2 请求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-App-UserId 否 String 第三方用户ID。 说明: *不允许输入中文。 表3 请求Body参数 参数 是否必选 参数类型 描述 file_name 是 String 文件名,不区分大小写,最大长度256,最小长度1。 file_md5 是 String 文件内容MD5值,MD5值需要进行Base64编码。编码后字符串长度是24字节。 file_size 是 Long 文件总的大小,最小1,最大5368709120。 file_type 是 String 文件类型(默认提取文件后缀)。 asset_id 是 String 资产ID。 asset_file_category 是 String 文件在资产中的分类。每种资产类型包含的文件分类不同。 MAIN:主文件 COVER:封面文件 PAGE:PPT内容页图片文件 SAMPLE:样例音频或样例动作文件 OTHER:其他文件 WHOLE_MODEL:全模型文件(3D数字人) USER_MODIFIED_MODEL:用户上传模型(3D数字人) 说明: 资产类型为SCENE、ANIMATION、VIDEO、IMAGE、MATERIAL时,包含MAIN、COVER和OTHER 资产类型为PPT时,包含MAIN、COVER、PAGE和OTHER 资产类型为HUMAN_MODEL时,包含MAIN、COVER、WHOLE_MODEL、USER_MODIFIED_MODEL和OTHER 资产类型为VOICE_MODEL时,包含MAIN、SAMPLE(样例音频文件)和OTHER 资产类型为HUMAN_MODEL_2D时,包含MAIN、COVER、SAMPLE(动作样例)和OTHER 资产类型为BUSINESS_CARD_TEMPLET时,包含MAIN和COVER(名片效果图) 资产类型为IMAGE时,包含MAIN 资产类型为VIDEO时,包含MAIN、COVER
  • 响应示例 状态码: 200 成功。 { "file_id" : "b2f8a9e9c39b6dc7ed4c0cfd67366c6a", "upload_url" : "https://digitalhuman.obs.cn-east-3.myhuaweicloud.com:443/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671154644&Signature=vXxiJTO239WZcG8sniotTe9qOc4%3D" } 状态码: 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" }
  • 请求示例 POST https://metastudio.cn-east-3.myhuaweicloud.com/v1/6a6a1f8354f64dd9b9a614def7b59d83/files { "file_name" : "1.png", "file_md5" : "n58IG6hfM7vqI4K0vnWpog==", "file_size" : 1048576, "file_type" : "png", "asset_id" : "8cb2f48a2cb006154794741933421100", "asset_file_category" : "MAIN" }
  • 修订记录 表1 修订记录 修改时间 修改说明 2023-09-19 第三次正式发布 本次变更如下: 新增数字人视频制作管理接口。 新增分身数字人视频制作管理接口。 新增数字人名片制作管理接口。 新增智能直播间管理接口。 新增直播任务管理接口。 2023-08-07 第二次正式发布 本次变更如下: 下线租户管理接口:查看租户自己的权限列表。数字内容生产线服务不再支持此接口功能。 更新3个接口的请求参数和响应参数,包括:查询资产列表、查询资产详情和获取语音驱动数据接口。 2022-12-27 第一次正式发布。
  • 响应示例 状态码: 200 处理成功返回。 { "commond_result" : "EXCUTE_SUCCESS" } 状态码: 400 { "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" } 状态码: 500 { "error_code" : "MSS.00000004", "error_msg" : "Internal Error" }
  • 响应参数 状态码: 200 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求ID。 表6 响应Body参数 参数 参数类型 描述 commond_result String 命令执行结果。 EXCUTE_SUCCESS: 命令提交成功 EXCUTE_FAILED: 命令提交失败 attachment_upload_url Array of strings 附件上传地址 multipart_data Array of MultipartUploadInfo objects 训练视频已上传分片信息 表7 MultipartUploadInfo 参数 参数类型 描述 part_number String 分片编号 etag String 分片文件标识 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
共100000条