更新时间:2024-11-18 GMT+08:00
分享

查询资产列表

功能介绍

该接口用于查询资产库中的媒体资产列表。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/digital-assets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示的条目数量。

取值范围:

1-100

默认取值:

10

offset

Integer

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

取值范围:

0-2147483647

默认取值:

0

name

String

按名称模糊查询。

tag

String

按标签模糊查询。

tag_combination_type

String

标签查询组合方式

INTERSECTION:交集

UNION_SET:并集

默认取值:

UNION_SET

start_time

String

起始时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。

end_time

String

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

asset_type

String

资产类型。多个类型使用英文逗号分隔。

  • HUMAN_MODEL:数字人模型

  • VOICE_MODEL:音色模型(仅系统管理员可上传)

  • SCENE:场景模型

  • ANIMATION:动作动画

  • VIDEO:视频文件

  • IMAGE:图片文件

  • PPT:幻灯片文件

  • MATERIAL:风格化素材

  • HUMAN_MODEL_2D: 2D数字人网络模型

  • BUSINESS_CARD_TEMPLET: 数字人名片模板

  • MUSIC: 音乐

  • AUDIO: 音频

sort_key

String

排序字段,支持的排序方式有:

  • 按创建时间排序:create_time

  • 按更新时间排序:update_time

  • 按资产排序:asset_order

sort_dir

String

排序方式。

  • asc:升序

  • desc:降序

默认asc升序。

asset_source

String

资产来源。

  • SYSTEM:系统资产

  • CUSTOMIZATION:租户资产

  • ALL:所有资产

默认查询租户资产。

默认取值:

CUSTOMIZATION

asset_state

String

资产状态。多个资产状态使用英文逗号分隔。

  • CREATING:资产创建中,主文件尚未上传

  • FAILED:主文件上传失败

  • UNACTIVED:主文件上传成功,资产未激活,资产不可用于其他业务(用户可更新状态)

  • ACTIVED:主文件上传成功,资产激活,资产可用于其他业务(用户可更新状态)

  • DELETING:资产删除中,资产不可用,资产可恢复

  • DELETED:资产文件已删除,资产不可用,资产不可恢复

  • BLOCK:资产被冻结,资产不可用,不可查看文件。

  • WAITING_DELETE:资产将被下线

    默认查询所有状态的资产。

style_id

String

基于风格化ID查询关联资产。

  • system_male_001:男性风格01

  • system_female_001:女性风格01

  • system_male_002:男性风格02

  • system_female_002:女性风格02

accurate_query_field

Array of strings

使用精确查询的字段

render_engine

String

可用引擎。

  • UE:UE引擎

  • MetaEngine:MetaEngine引擎

说明:

该字段当前只对MetaEngine白名单用户生效

asset_id

Array of strings

资产id

sex

String

性别。多选使用英文逗号分隔。

language

String

语言。多选使用英文逗号分隔。

system_property

String

系统属性。

key和value间用":"分隔,多个key之间用","分隔。

如system_property=BACKGROUND_IMG:Yes,RENDER_ENGINE:MetaEngine。

不同Key对应Value取值如下:

公共资产属性:

  • BACKGROUND_IMG:视频制作的2D背景图片,可取值Yes

  • CREATED_BY_PLATFORM:是否平台生成,可取值Yes

分身数字人资产属性:

  • MATERIAL_IMG:素材图片,用作前景。可取值Yes

  • MATERIAL_VIDEO:素材视频,用作前景。可取值Yes

  • TO_BE_TRANSLATED_VIDEO: 视频翻译的源视频。可取值Yes

3D数字人资产属性:

  • STYLE_ID:风格Id

  • RENDER_ENGINE:引擎类型,可取值UE或MetaEngine

  • BACKGROUND_SCENE:视频制作的2D背景场景,可取值Horizontal(横屏)或者Vertical(竖屏)

action_editable

Boolean

动作是否可编辑。仅在分身数字人模型查询时有效。

is_with_action_library

Boolean

分身数字人是否带原子动作库。

说明:
  • 带原子动作库的分身数字人可做动作编排。

is_movable

Boolean

分身数字人是否支持走动。仅在分身数字人模型查询时有效。

voice_provider

String

取值:HUAWEI_METASTUDIO、MOBVOI。

HUAWEI_METASTUDIO:MetaStudio自研音色

MOBVOI:出门问问音色

role

String

角色。 SHARER:共享方,SHAREE:被共享方

is_realtime_voice

Boolean

音色是否支持实时合成。仅在音色查询时有效。

说明:
  • 支持实时合成的音色,可以用于直播和智能交互场景。否则只能用于视频制作。

human_model_2d_version

String

模型版本

include_device_name

String

资产已执行的任务名称

exclude_device_name

String

资产已执行的任务名称

supported_service

String

资产支持的业务类型。默认查询所有资产。

  • VIDEO_2D:分身数字人视频制作

  • LIVE_2D:分身数字人直播

  • CHAT_2D:分身数字人智能交互

请求参数

表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

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表5 响应Body参数

参数

参数类型

描述

count

Integer

资产总数。

取值范围:

0-2147483647

assets

Array of DigitalAssetInfo objects

资产信息列表。

表6 DigitalAssetInfo

参数

参数类型

描述

project_id

String

租户id

asset_id

String

资产ID。

asset_name

String

资产名称。

asset_description

String

资产描述。

app_user_id

String

第三方用户ID。

说明:
  • 即创建资产是通过X-App-UserId头域传入的值。

create_time

String

资产创建时间。

update_time

String

资产更新时间。

asset_type

String

资产类型。

公共资产类型:

  • VOICE_MODEL:音色模型

  • VIDEO:视频文件

  • IMAGE:图片文件

  • PPT:幻灯片文件

  • MUSIC: 音乐

  • AUDIO: 音频

  • COMMON_FILE:通用文件

分身数字人资产类型:

  • HUMAN_MODEL_2D:分身数字人模型

  • BUSINESS_CARD_TEMPLET: 数字人名片模板

3D数字人资产类型:

  • HUMAN_MODEL:3D数字人模型

  • SCENE:场景模型

  • ANIMATION:动作动画

  • MATERIAL:风格化素材

  • NORMAL_MODEL: 普通模型

asset_state

String

资产状态。

  • CREATING:资产创建中,主文件尚未上传

  • FAILED:主文件上传失败

  • UNACTIVED:主文件上传成功,资产未激活,资产不可用于其他业务(用户可更新状态)

  • ACTIVED:主文件上传成功,资产激活,资产可用于其他业务(用户可更新状态)

  • DELETING:资产删除中,资产不可用,资产可恢复

  • DELETED:资产文件已删除,资产不可用,资产不可恢复

  • BLOCK: 资产被冻结,资产不可用,不可查看文件。

  • WAITING_DELETE:资产将被下线

fail_type

String

失败原因。

  • AUTOMATIC_REVIEW_REJECT:自动审核失败

  • MANUAL_REVIEW_REJECT:人工审核失败

默认取值:

AUTOMATIC_REVIEW_REJECT

reason

String

冻结/解冻/失败 原因。

tags

Array of strings

标签列表。

说明:

分身形象系统资产的tag定义如下:

  • 行业:NEWS,BUSINESS,E-COMMERCE,MARKETING,KNOWLEDGE,EDUCATION,SPORTS

  • 性别:MALE,FEMALE

  • 姿势:FULL-BODY,HALF-BODY,STANDING,SITTING,WALKING

  • 区域:ASIAN,WESTERN,MIDDLE-EASTERNER,AFRICAN,LATINO

asset_extra_meta

AssetExtraMeta object

参数解释

资产额外元数据。

约束限制

根据asset_type选择对应结构填写,填写其他不匹配的结构会被忽略。

  • HUMAN_MODEL: 填写human_model_meta

  • HUMAN_MODEL_2D: 填写human_model_2d_meta

  • SCENE:填写scene_meta

  • ANIMATION:填写animation_meta

  • MATERIAL:填写material_meta

  • VOICE_MODEL:填写voice_model_meta

  • VIDEO:填写video_meta

  • IMAGE:填写image_meta

  • PPT:填写ppt_meta

  • AUDIO: 填写audio_meta

system_properties

Array of SystemProperty objects

设置系统属性。

files

Array of AssetFileInfo objects

资产下的文件。

asset_order

Integer

展示顺序

取值范围:

0-32767

supported_service

Array of strings

支持的业务类型。:

  • VIDEO_2D:分身数字人视频制作

  • LIVE_2D:分身数字人直播

  • CHAT_2D:分身数字人智能交互

表7 AssetExtraMeta

参数

参数类型

描述

human_model_meta

HumanModelAssetMeta object

数字人模型元数据。

voice_model_meta

VoiceModelAssetMeta object

音色模型元数据。

ppt_meta

PPTAssetMeta object

PPT资产元数据信息。

animation_meta

AnimationAssetMeta object

动作动画资产元数据。

scene_meta

SceneAssetMeta object

场景元数据。

material_meta

MaterialAssetMeta object

素材元数据。

human_model_2d_meta

HumanModel2DAssetMeta object

分身模型元数据

image_meta

ImageAssetMeta object

图片元数据

video_meta

VideoAssetMeta object

视频元数据,自动提取获得。

audio_meta

AudioAssetMeta object

音频元数据,自动提取获得。

表8 HumanModelAssetMeta

参数

参数类型

描述

style_id

String

参数解释

数字人模型风格ID。

约束限制

当前仅支持系统提供的几种风格。

取值范围

  • system_male_001:男性风格01

  • system_female_001:女性风格01

  • system_male_002:男性风格02

  • system_female_002:女性风格02

默认取值

不涉及

modeling_type

String

参数解释

数字人模型建模类型。

约束限制

不涉及

取值范围

  • UPLOADED:租户上传的模型

  • PICTURE_MODELING:照片建模生成的模型

  • CHARACTER_CUSTOMIZATION_MODELING:捏脸生成的模型

默认取值:

UPLOADED

modeling_job_id

String

参数解释

建模任务ID。

约束限制

仅由MetaStudio服务生成的模型系统自行填写

取值范围

字符长度0-64位。

默认取值

不涉及。

model_properties

HumanModelMetaProperties object

记录模型配置信息

components

Array of ComponentInfo objects

可替换组件列表。

表9 HumanModelMetaProperties

参数

参数类型

描述

whole_model_base_file_id

String

参数解释

用于生成WHOLE_MODEL的模型file_id

约束限制

如果当前记录的信息与MAIN文件的file_id一致,那就认为已经生成过,无需再进行全模型导出

取值范围

字符长度0-64位。

默认取值

不涉及。

load_model_file_id

String

参数解释

当前用于渲染加载的模型file_id

约束限制

若为空或未匹配到,则使用MAIN文件

取值范围

字符长度0-64位。

默认取值

不涉及。

表10 ComponentInfo

参数

参数类型

描述

component_name

String

参数解释

组件名称。

约束限制

不涉及。

取值范围

字符长度1-256位。

默认取值

不涉及。

component_type

String

参数解释

组件类型。

约束限制

不涉及。

取值范围

字符长度1-256位。

默认取值

不涉及。

component_desc

String

参数解释

组件描述。

约束限制

不涉及。

取值范围

字符长度0-512位。

默认取值

不涉及。

表11 VoiceModelAssetMeta

参数

参数类型

描述

order

Integer

参数解释

展示顺序。

约束限制

不涉及。

取值范围:

0-32767

默认取值:

999

model_type

String

参数解释

声音资产类型。

约束限制

不涉及。

取值范围

  • COMMON:通用情感模型

  • CLONE:语音克隆模型

默认取值:

CLONE

sex

String

参数解释

声音性别。

约束限制

不涉及。

取值范围

  • UNKNOW:未知性别声音

  • MALE:男性声音

  • FEMALE:女性声音

默认取值:

UNKNOW

language

String

参数解释

声音语言。

约束限制

不涉及。

取值范围

  • UNKNOW:未知

  • CN:中文

  • EN:英文

  • GER:德语

  • fr:法语

  • Kr:韩语

  • por:葡萄牙语

  • JPN:日语

  • Ita:意大利语

  • ESP:西班牙语

  • DBH:东北话

  • GT:港台

  • GXH:广西话

  • HBH:湖北话

  • SXH:陕西话

  • SCH:四川话

  • YY:粤语

  • Russian: 俄罗斯语

  • Filipino: 菲律宾语

  • Dutch: 荷兰语

  • Indonesian: 印尼语

  • Vietnamese: 越南语

  • Arabic: 阿拉伯语

  • Turkish: 土耳其语

  • Malay: 马来语

  • Thai: 泰语

  • Finnish: 芬兰语

默认取值:

UNKNOW

speed_ratio

Float

参数解释

语速缩放比例。

约束限制

不涉及

取值范围:

0-100

默认取值:

1

volume_ratio

Float

参数解释

音量缩放比例。

约束限制

不涉及

取值范围:

0-100

默认取值:

1

is_realtime_voice

Boolean

参数解释

该音色是否支持实时合成。

约束限制

支持实时合成的音色,可以用于直播和智能交互场景。否则只能用于视频制作。

取值范围

  • true: 支持实时合成

  • false: 不支持实时合成

默认取值:

true

style

String

风格参考

voice_capability

VoiceCapability object

音色资产支持的能力集。

说明:

音色能力集只允许查询,不允许设置

external_voice_meta

ExternalVoiceAssetMeta object

第三方TTS音色元数据。

is_support_vc_process

Boolean

是否支持vc。

默认取值:

false

is_flexus

Boolean

是否是Flexus版本声音。

默认取值:

false

表12 VoiceCapability

参数

参数类型

描述

is_support_phoneme_en

Boolean

参数解释

该声音是否支持英文音标。

约束限制

不涉及

取值范围

  • true: 支持英文音标

  • false: 不支持英文音标

默认取值:

false

is_support_phoneme

Boolean

参数解释

该声音是否支持中文多音字。

约束限制

不涉及

取值范围

  • true: 支持中文多音字

  • false: 不支持中文多音字

默认取值:

false

is_support_break_time

Boolean

参数解释

该声音是否支持停顿。

约束限制

不涉及

取值范围

  • true: 支持停顿

  • false: 不支持停顿

默认取值:

false

is_support_break_strength

Boolean

参数解释

该声音是否支持韵律。

约束限制

不涉及

取值范围

  • true: 支持韵律

  • false: 不支持韵律

默认取值:

false

is_support_speed

Boolean

参数解释

该声音是否支持全局语速。

约束限制

不涉及

取值范围

  • true: 支持全局语速

  • false: 不支持全局语速

默认取值:

false

is_support_prosody

Boolean

参数解释

该声音是否支持局部语速。

约束限制

不涉及

取值范围

  • true: 支持局部语速

  • false: 不支持局部语速

默认取值:

false

is_support_ssml_say_as

Boolean

参数解释

该声音是否支持SSML的say-as标签。

约束限制

不涉及

取值范围

  • true: 支持SSML的say-as标签

  • false: 不支持SSML的say-as标签

默认取值:

false

is_support_ssml_sub

Boolean

参数解释

该声音是否支持SSML的sub标签。

约束限制

不涉及

取值范围

  • true: 支持SSML的sub标签

  • false: 不支持SSML的sub标签

默认取值:

false

is_support_word

Boolean

参数解释

该声音是否支持连读。

约束限制

不涉及

取值范围

  • true: 支持连读

  • false: 不支持连读

默认取值:

false

is_support_voice_cache

Boolean

是否支持缓存。

默认取值:

false

conversion_rate

Float

参数解释

合成率。

约束限制

不涉及

取值范围

  • 0-50

取值范围:

0-50

默认取值:

0.0

conversion_rate_en

Float

参数解释

英语的合成率。

约束限制

不涉及

取值范围

  • 0-50

取值范围:

0-50

默认取值:

0.0

is_support_srt

Boolean

是否支持生成STR字幕文件。

默认取值:

false

表13 ExternalVoiceAssetMeta

参数

参数类型

描述

provider

String

第三方TTS供应商类型。

  • XIMALAYA:喜马拉雅TTS

  • HUAWEI_EI:华为云EI TTS

  • MOBVOI:出门问问 TTS

  • AUDIOX:逻辑智能 TTS

  • SINOVOICE:捷通华声 TTS

  • DATABAKER:标贝 TTS

  • AISPEECH:思必驰 TTS

表14 PPTAssetMeta

参数

参数类型

描述

auto_analysis

Boolean

参数解释

PPT是否需要自动解析。

约束限制

部分过于复杂的PPT或压缩比过高的PPT可能无法解析。

超过50页PPT仅转换50页

转换的图片无法保证完全还原,需要自行确认。

取值范围

  • true: 自动解析

  • false: 无需解析

默认取值:

false

ppt_analysis_status

String

参数解释

PPT解析状态。

约束限制

不涉及

取值范围

  • INITIALIZE:初始

  • WAITING:等待

  • CONVERTING:解析中

  • FAILED:失败

  • SUCCEEDED:成功

  • CANCELED:取消

默认取值

不涉及

error_info

ErrorResponse object

错误信息

page_count

Integer

参数解释

PPT页面总数。

约束限制

不涉及

取值范围:

0-256

默认取值:

0

pages

Array of PPTPageInfo objects

PPT页面图片。

表15 PPTPageInfo

参数

参数类型

描述

page_no

Integer

参数解释

页面编号。

约束限制

不涉及

取值范围:

1-256

file_id

String

参数解释

页面对应图片文件ID。

约束限制

不涉及

取值范围

字符长度1-64位

默认取值

不涉及

page_content

String

参数解释

页面对应图片文件ID

约束限制

不涉及

取值范围

字符长度0-2048位

默认取值

不涉及。

表16 AnimationAssetMeta

参数

参数类型

描述

style_id

String

数字人模型风格ID。

duration

Float

动作动画时长。

取值范围:

0-32767

默认取值:

0

auto_analysis

Boolean

动作是否需要自动解析。

默认取值:

false

voice_delay

Float

语音延迟播放时长。

单位秒。

使用场景举例:入场动画3秒,voice_delay设置成4秒,则语音从入场动画开始后第4秒开始播放。

取值范围:

0-100

默认取值:

0

animation_insert_restriction

String

动画插入位置限制。

  • ONLY_BEGINNING:视频制作时,动画只允许出现在起始位置。

  • ONLY_END:视频制作时,动画只允许出现在结束位置。

表17 SceneAssetMeta

参数

参数类型

描述

components

Array of SceneComponentInfo objects

可操作组件列表(如屏幕,灯光,摄像机)。

default_configs

Map<String,SceneComponentInfo>

默认场景设置(机位,初始人位置)。

表18 SceneComponentInfo

参数

参数类型

描述

index

Integer

组件索引。

取值范围:

1-10

component_name

String

组件名称。

component_type

String

组件类型。

  • CAMERA:摄像机

  • PANEL:屏幕

  • LIGHT:灯光

component_desc

String

组件描述。

表19 MaterialAssetMeta

参数

参数类型

描述

components

Array of MaterialComponentInfo objects

可替换的素材组件列表。

表20 MaterialComponentInfo

参数

参数类型

描述

component_name

String

素材组件名称。

component_type

String

素材组件类型。

  • CLOTHES:衣服

  • PANTS:裤子

  • SHOES:鞋子

  • HAIR:头发

  • EYELASH:睫毛

  • EYEBROW:眉毛

component_desc

String

素材组件描述。

表21 HumanModel2DAssetMeta

参数

参数类型

描述

is_action_editable

Boolean

参数解释

分身数字人的动作是否可编辑

约束限制

不涉及

取值范围

  • true: 动作可编辑

  • false: 动作不可编辑

默认取值:

false

is_real_background

Boolean

参数解释

是否是实景分身数字人

约束限制

实景分身数字人不做背景替换。

取值范围

  • true: 实景分身数字人

  • false: 普通分身数字人,不带背景。

默认取值:

false

support_live

Boolean

参数解释

是否支持直播

约束限制

不涉及

取值范围

  • true: 支持直播

  • false: 不支持直播。

默认取值:

false

model_version

String

参数解释

分身数字人模型版本

约束限制

不涉及

取值范围

  • V2: V2版本模型

  • V3:V3版本模型

  • V3_2:V3.2版本模型

默认取值:

V2

model_resolution

String

参数解释

分身数字人模型分辨率。

约束限制

不涉及

取值范围

  • 1080P:1080P。支持1080P及720P的视频输出。

  • 4K:4K。支持4K、1080P及720P的视频输出。

默认取值:

1080P

device_names

Array of strings

参数解释

已执行编译任务设备类型列表。

约束限制

支持走动的数字人,当前仅用于视频制作,不能用于直播和智能交互

取值范围

设备名称列表最多16个。

设备名称字符长度1-64位。

默认取值

false

is_with_action_library

Boolean

分身数字人是否带原子动作库。

说明:
  • 带原子动作库的分身数字人可做动作编排。

默认取值:

false

action_tag_map

Array of ActionTagInfo objects

动作标签映射。

is_flexus

Boolean

是否是Flexus版本分身数字人。

默认取值:

false

表22 ActionTagInfo

参数

参数类型

描述

action_name_zh

String

原子动作中文名称。

action_name_en

String

原子动作英文名称。

catalog

String

动作分类名称。

file_name

String

样例视频文件名,最大长度256,最小长度1。

tag

String

动作标签。

表23 ImageAssetMeta

参数

参数类型

描述

codec

String

参数解释

图片编码格式。

约束限制

用户无需填写,系统自行提取。

取值范围

字符长度0-32位。

默认取值

不涉及。

width

Integer

参数解释

图片宽度。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及。

取值范围:

0-8196

height

Integer

参数解释

图片高度。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及。

取值范围:

0-8196

size

Long

参数解释

图片大小。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及。

取值范围:

0-9223372036854775807

mode

String

参数解释

图片形态。

约束限制

用户无需填写,系统自行提取。

取值范围

  • Horizontal:横向

  • Vertical:纵向

默认取值

不涉及。

error_info

ErrorResponse object

错误信息

表24 VideoAssetMeta

参数

参数类型

描述

video_codec

String

参数解释

视频编码格式。

约束限制

用户无需填写,系统自行提取。

取值范围

字符长度0-32位。

默认取值

不涉及

width

Integer

参数解释

视频画面宽度。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-8196

height

Integer

参数解释

视频画面高度。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-8196

frame_rate

String

参数解释

视频帧率。

约束限制

用户无需填写,系统自行提取。

取值范围

字符长度0-32位。

默认取值

不涉及

video_bit_rate

Integer

参数解释

视频平均码率,单位kbps。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-104857600

duration

Integer

参数解释

时长,单位秒。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-86400

audio_codec

String

参数解释

音频编码格式。

约束限制

用户无需填写,系统自行提取。

取值范围

字符长度0-32位。

默认取值

不涉及

audio_bit_rate

Integer

参数解释

音频平均码率,单位kbps。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-16384

audio_channels

Integer

参数解释

音频声道数。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-100

sample

Integer

参数解释

采样率,HZ。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-100000

mode

String

参数解释

横向画面或纵向画面。

约束限制

用户无需填写,系统自行提取。

取值范围

  • Horizontal:横向

  • Vertical:纵向

默认取值

不涉及

video_transcoding_status

String

参数解释

视频转码状态。

约束限制

用户无需填写,系统自行填写。

取值范围

  • WAITING:等待

  • TRANSCODING:转码中

  • FAILED:失败

  • SUCCEEDED:成功

默认取值

不涉及

error_info

ErrorResponse object

错误信息

表25 AudioAssetMeta

参数

参数类型

描述

duration

Integer

参数解释

时长,单位秒。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-86400

audio_codec

String

参数解释

音频编码格式。

约束限制

用户无需填写,系统自行提取。

取值范围

字符长度0-32位。

默认取值

不涉及

audio_bit_rate

Integer

参数解释

音频平均码率,单位kbps。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-16384

audio_channels

Integer

参数解释

音频声道数。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-100

sample

Integer

参数解释

采样率,HZ。

约束限制

用户无需填写,系统自行提取。

默认取值

不涉及

取值范围:

0-100000

error_info

ErrorResponse object

错误信息

表26 ErrorResponse

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

表27 SystemProperty

参数

参数类型

描述

action

String

参数解释

操作。

约束限制

系统属性仅为系统设置,普通用户无法修改。

取值范围

  • ADD:增加

  • DELETE:删除

默认取值

不涉及

key

String

参数解释

系统属性条目。

约束限制

系统属性仅为系统设置,普通用户无法修改。

取值范围

公共资产属性:

  • BACKGROUND_IMG:视频制作的背景图片。value设置成Yes

  • CREATED_BY_PLATFORM: 是否平台生成。

分身数字人资产属性:

  • MATERIAL_IMG:素材图片,用作图片图层。value设置成Yes,否则控制台视频制作、直播等界面的贴图区域,将无法看到此图片。

  • MATERIAL_VIDEO:素材视频,用作视频图层。value设置成Yes,否则控制台视频制作、直播等界面的视频区域,将无法看到此视频。

  • DIGITAL_HUMAN_2D_VIDEO:分身数字人视频。

  • DIGITAL_HUMAN_3D_VIDEO:3D数字人视频。

  • BUSINESS_CARD_VIDEO:名片视频。

  • BUSSINESS_CARD_VIDEO:名片视频(过期)

  • PHOTO_VIDEO:照片数字人视频。

视频翻译资产属性:

  • TO_BE_TRANSLATED_VIDEO: 视频翻译的源视频。可取值Yes。

  • TRANSLATED_VIDEO: 视频翻译后的视频

3D数字人资产属性:

  • STYLE_ID:风格Id。

  • DH_ID:数字人ID(尚未启用)。

  • PLATFORM_AVAILABLE:是否平台可用(尚未启用)。

  • RENDER_ENGINE:引擎类型。value可选UE或MetaEngine。

  • BACKGROUND_SCENE:视频制作的2D背景场景。value可选Horizontal(横屏)或者Vertical(竖屏)。

  • LAYER_CONFIG_ENABLE: 可用前景图层配置

  • MEITUAN_MATERIAL_APPROVED: 美团平台已审核标识,value设置成YES。

默认取值

不涉及

value

String

参数解释

系统属性属性值。

约束限制

系统属性仅为系统设置,普通用户无法修改。

取值范围

字符长度1-1024位

默认取值

不涉及

表28 AssetFileInfo

参数

参数类型

描述

file_id

String

文件ID。

file_name

String

文件名创建文件时候不区分大小写,最大长度256,最小长度1。

file_md5

String

文件内容MD5值,固定24位。

file_size

Long

文件总的大小,最小1,最大5368709120。

取值范围:

1-5368709120

file_type

String

文件类型(默认提取文件后缀)。

asset_file_category

String

文件在资产中的分类。每种资产类型包含的文件分类不同。

  • MAIN:主文件

  • COVER:封面文件

  • PAGE:内容页图片

  • SAMPLE:样例音频

  • OTHER:其他文件

  • WHOLE_MODEL:全模型

  • USER_MODIFIED_MODEL:用户上传模型

  • TEMPORARY:临时文件夹(用于文件替换时上传新文件)

说明:
  • 资产类型为SCENE、ANIMATION、VIDEO、IMAGE、MATERIAL时,包含MAIN、COVER和OTHER

  • 资产类型为PPT时,包含MAIN、COVER、PAGE和OTHER

  • 资产类型为HUMAN_MODEL时,包含MAIN、COVER和OTHER

  • 资产类型为VOICE_MODEL时,包含MAIN、SAMPLE(样例音频文件)和OTHER

  • 资产类型为HUMAN_MODEL_2D时,包含MAIN、COVER、SAMPLE(动作样例)和OTHER(遮罩文件)

  • 资产类型为BUSINESS_CARD_TEMPLET时,包含MAIN和COVER(名片效果图)

download_url

String

文件下载URL,有效期为24小时。

state

String

文件状态枚举:

  • CREATING:文件上传中

  • CREATED:文件已上传(自动审核通过)

  • FAILED:文件上传失败

  • CANCELLED:文件上传已取消

  • DELETING:文件删除中

  • DELETED:文件已删除

  • UPLOADED:文件已上传(尚未审核)

  • REVIEW:人工审核(文件已上传)

  • BLOCK:冻结

reason

String

审核失败原因

file_extra_meta

FileExtraMeta object

文件数据。

表29 FileExtraMeta

参数

参数类型

描述

video_transcoding_status

String

视频转码状态。

  • WAITING:等待

  • TRANSCODING:转码中

  • FAILED:失败

  • SUCCEEDED:成功

状态码: 400

表30 响应Body参数

参数

参数类型

描述

BadRequest

AnyType

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

请求示例

GET https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/digital-assets

响应示例

状态码: 200

成功。

{
  "count" : 1,
  "assets" : [ {
    "asset_id" : "24bad716-87b1-45e5-8912-6102f7693265",
    "asset_name" : "文旅3",
    "asset_description" : "背景图片",
    "create_time" : "2021-10-30T12:30:35Z",
    "asset_type" : "IMAGE",
    "asset_state" : "ACTIVED",
    "tags" : [ "文旅" ],
    "files" : [ {
      "file_id" : "93769b5a-c8c6-4692-9c95-53933a1f0c93",
      "file_name" : "文旅风3.png",
      "file_md5" : "6sxnj34jQZFvuJhXRwD7nw==",
      "file_size" : 6519699,
      "file_type" : "png",
      "asset_file_category" : "MAIN",
      "download_url" : "https://metastudio.obs.cn-north-4.myhuaweicloud.com:443/SYSTEM/d6e7dde03cab4ce06f2c3cbb19f2682c/9fd37af847980ae086c98d282570bd72.png?AWSAccessKeyId=MYEO6O12LEA6YE2TYTW8&Expires=1706739167&response-content-disposition=attachment%3B+filename*%3Dutf-8%27%27%25E6%2596%2587%25E6%2597%2585%25E9%25A3%258E3.png&x-amz-security-token=ggpjbi1ub3JQ4IEfiM6O&Signature=NzXKRDLDNmkWQI4axyMrTMtKS8k%3D",
      "state" : "CREATED"
    } ]
  } ]
}

状态码: 400

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

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

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion;
import com.huaweicloud.sdk.metastudio.v1.*;
import com.huaweicloud.sdk.metastudio.v1.model.*;


public class ListAssetsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        MetaStudioClient client = MetaStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAssetsRequest request = new ListAssetsRequest();
        try {
            ListAssetsResponse response = client.listAssets(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkmetastudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = MetaStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAssetsRequest()
        response = client.list_assets(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := metastudio.NewMetaStudioClient(
        metastudio.MetaStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAssetsRequest{}
	response, err := client.ListAssets(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

成功。

400

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

错误码

请参见错误码

相关文档