Querying Assets
Function
You can query media assets in the asset library.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/digital-assets
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of items displayed on each page. Value range: 1-100 Default value: 10 |
offset |
No |
Integer |
Offset where the query starts. Value range: 0-2147483647 Default value: 0 |
name |
No |
String |
Fuzzy search by name. |
tag |
No |
String |
Fuzzy search by tag. |
tag_combination_type |
No |
String |
Tag query combination mode INTERSECTION: intersection UNION_SET: union Default value: UNION_SET |
start_time |
No |
String |
Start time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z. |
end_time |
No |
String |
End time. The format complies with RFC 3339, for example, 2021-01-10T10:43:17Z. |
asset_type |
No |
String |
Asset type. If there are more than one, separate them with commas (,).
|
sort_key |
No |
String |
Sorting field. Options:
|
sort_dir |
No |
String |
Sorting mode.
asc is used by default. |
asset_source |
No |
String |
Asset source.
Tenant assets are queried by default. Default value: CUSTOMIZATION |
asset_state |
No |
String |
Asset status. Use commas (,) to separate multiple asset statuses.
|
style_id |
No |
String |
Query associated assets by style ID.
|
accurate_query_field |
No |
Array of strings |
Use the field for exact query. |
render_engine |
No |
String |
Available engine.
This field is valid only for users in the MetaEngine whitelist. |
asset_id |
No |
Array of strings |
Asset ID. |
sex |
No |
String |
Gender. Use commas (,) to separate multiple options. |
language |
No |
String |
Language. If there is more than one, separate them with commas (,). |
system_property |
No |
String |
System attribute. key and value are separated with colons (:). Use commas (,) to separate them if there are more than one key. For example, system_property=BACKGROUND_IMG:Yes,RENDER_ENGINE:MetaEngine. Options: Public asset attribute. Options:
Virtual avatar asset attribute. Options:
3D virtual human asset attribute. Options:
|
action_editable |
No |
Boolean |
Indicates whether an action is editable. This parameter is only available for virtual avatar model query. |
is_with_action_library |
No |
Boolean |
Whether the virtual avatar has an atomic action library.
|
is_movable |
No |
Boolean |
Whether a virtual avatar can walk. This parameter is valid only for querying virtual human models. |
voice_provider |
No |
String |
The value can be HUAWEI_METASTUDIO or MOBVOI. HUAWEI_METASTUDIO: MetaStudio's proprietary timbre MOBVOI: Mobvoi's timbre |
role |
No |
String |
Role. SHARER: sharer. SHAREE: sharee |
is_realtime_voice |
No |
Boolean |
Whether the timbre supports real-time compositing. This parameter is valid only for timbre query.
|
human_model_2d_version |
No |
String |
Model version |
include_device_name |
No |
String |
Name of a compilation task that has been executed under an asset |
exclude_device_name |
No |
String |
Name of a compilation task that has been executed under an asset |
supported_service |
No |
String |
Service type supported by an asset. By default, all assets are queried.
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header. |
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'. |
X-App-UserId |
No |
String |
Third-party user ID, which does not allow Chinese characters. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Request ID. |
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total assets. Value range: 0-2147483647 |
assets |
Array of DigitalAssetInfo objects |
Asset information list. |
Parameter |
Type |
Description |
---|---|---|
project_id |
String |
Tenant ID |
asset_id |
String |
Asset ID. |
asset_name |
String |
Asset name. |
asset_description |
String |
Asset description. |
app_user_id |
String |
Third-party user ID.
|
create_time |
String |
Time when an asset is created. |
update_time |
String |
Time when an asset is updated. |
asset_type |
String |
Asset types. Public asset type. Options:
Virtual avatar asset type. Options:
3D virtual human asset type. Options:
|
asset_state |
String |
Asset status.
|
fail_type |
String |
Failure causes:
Default value: AUTOMATIC_REVIEW_REJECT |
reason |
String |
Freezing, unfreezing, and failure causes. |
tags |
Array of strings |
Tags. Avatar system asset tag definition:
|
asset_extra_meta |
AssetExtraMeta object |
Details: Additional asset metadata. Constraints: Select a structure based on asset_type. Other unmatched structures will be ignored.
|
system_properties |
Array of SystemProperty objects |
Sets system attributes. |
files |
Array of AssetFileInfo objects |
Files under an asset. |
asset_order |
Integer |
Display order Value range: 0-32767 |
supported_service |
Array of strings |
Supported service type. Options:
|
Parameter |
Type |
Description |
---|---|---|
human_model_meta |
HumanModelAssetMeta object |
Virtual human model metadata. |
voice_model_meta |
VoiceModelAssetMeta object |
Timbre model metadata. |
ppt_meta |
PPTAssetMeta object |
PPT asset metadata information. |
animation_meta |
AnimationAssetMeta object |
Animated action asset metadata. |
scene_meta |
SceneAssetMeta object |
Scenario metadata. |
material_meta |
MaterialAssetMeta object |
Material metadata. |
human_model_2d_meta |
HumanModel2DAssetMeta object |
Virtual avatar model metadata |
image_meta |
ImageAssetMeta object |
Image metadata |
video_meta |
VideoAssetMeta object |
Video metadata, which is automatically extracted. |
audio_meta |
AudioAssetMeta object |
Audio metadata, which is automatically extracted. |
Parameter |
Type |
Description |
---|---|---|
style_id |
String |
Details: Virtual human model style ID. Constraints: Currently, only the preset styles are supported. Options:
Default value: N/A |
modeling_type |
String |
Details: Virtual human modeling type. Constraints: N/A Options:
Default value: UPLOADED |
modeling_job_id |
String |
Details: Modeling task ID. Constraints: This parameter is automatically specified only when it is a model generated by MetaStudio. Options: The value contains 0 to 64 characters. Default value: N/A |
model_properties |
HumanModelMetaProperties object |
Records model configuration information. |
components |
Array of ComponentInfo objects |
Replaceable components. |
Parameter |
Type |
Description |
---|---|---|
whole_model_base_file_id |
String |
Details: Model file_id used to generate WHOLE_MODEL Constraints: If the recorded information is the same as the value of file_id in the main file, the model has been generated and there is no need to export the entire model. Options: The value contains 0 to 64 characters. Default value: N/A |
load_model_file_id |
String |
Details: Model file_id used for rendering. Constraints: If the value is empty or no match is found, the main file is used. Options: The value contains 0 to 64 characters. Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
component_name |
String |
Details: Component name. Constraints: N/A Options: The value contains 1 to 256 characters. Default value: N/A |
component_type |
String |
Details: Component type. Constraints: N/A Options: The value contains 1 to 256 characters. Default value: N/A |
component_desc |
String |
Details: Component description. Constraints: N/A Options: The value contains 0 to 512 characters. Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
order |
Integer |
Details: Display order. Constraints: N/A Value range: 0-32767 Default value: 999 |
model_type |
String |
Details: Voice asset type. Constraints: N/A Options:
Default value: CLONE |
sex |
String |
Details: Voice gender. Constraints: N/A Options:
Default value: UNKNOW |
language |
String |
Details: Voice language. Constraints: N/A Options:
Default value: UNKNOW |
speed_ratio |
Float |
Details: Speaking speed zoom ratio. Constraints: N/A Value range: 0-100 Default value: 1 |
volume_ratio |
Float |
Details: Volume zoom ratio. Constraints: N/A Value range: 0-100 Default value: 1 |
is_realtime_voice |
Boolean |
Details: Whether the timbre supports real-time synthesis. Constraints: Timbre that supports real-time synthesis can be used for livestreaming and intelligent interaction. Timbre that does not support real-time synthesis can only be used for video production. Options:
Default value: true |
style |
String |
Style reference |
voice_capability |
VoiceCapability object |
Capability set supported by the timbre asset. The timbre capability set can be queried but cannot be configured. |
external_voice_meta |
ExternalVoiceAssetMeta object |
Third-party TTS timbre metadata. |
is_support_vc_process |
Boolean |
Whether VC is supported. Default value: false |
is_flexus |
Boolean |
Whether the voice is of the Flexus edition. Default value: false |
Parameter |
Type |
Description |
---|---|---|
is_support_phoneme_en |
Boolean |
Details: Whether the voice supports English phonetics. Constraints: N/A Options:
Default value: false |
is_support_phoneme |
Boolean |
Details: Whether the voice supports Chinese multi-pronunciation words. Constraints: N/A Options:
Default value: false |
is_support_break_time |
Boolean |
Details: Whether the voice supports pauses. Constraints: N/A Options:
Default value: false |
is_support_break_strength |
Boolean |
Details: Whether the voice supports rhythm. Constraints: N/A Options:
Default value: false |
is_support_speed |
Boolean |
Details: Whether the voice supports global speaking speed. Constraints: N/A Options:
Default value: false |
is_support_prosody |
Boolean |
Details: Whether the voice supports local speaking speed. Constraints: N/A Options:
Default value: false |
is_support_ssml_say_as |
Boolean |
Details: Whether the voice supports say-as SSML tags. Constraints: N/A Options:
Default value: false |
is_support_ssml_sub |
Boolean |
Details: Whether the voice supports sub SSML tags. Constraints: N/A Options:
Default value: false |
is_support_word |
Boolean |
Details: Whether the voice supports continuous reading. Constraints: N/A Options:
Default value: false |
is_support_voice_cache |
Boolean |
Whether cache is supported. Default value: false |
conversion_rate |
Float |
Details: Synthesis rate. Constraints: N/A Options:
Value range: 0-50 Default value: 0.0 |
conversion_rate_en |
Float |
Details: Synthesis rate of English. Constraints: N/A Options:
Value range: 0-50 Default value: 0.0 |
is_support_srt |
Boolean |
Indicates whether to generate STR subtitle files. Default value: false |
Parameter |
Type |
Description |
---|---|---|
provider |
String |
Third-party TTS vendor. Options:
|
Parameter |
Type |
Description |
---|---|---|
auto_analysis |
Boolean |
Details: Whether the PowerPoint file needs to be automatically parsed. Constraints: Parsing some complex PowerPoint files or PowerPoint files with a high compression ratio may fail. If the PowerPoint file contains more than 50 pages, only the first 50 pages will be converted. The converted images may not be completely restored. You need to confirm the restoration result. Options:
Default value: false |
ppt_analysis_status |
String |
Details: PowerPoint file parsing status. Constraints: N/A Options:
Default value: N/A |
error_info |
ErrorResponse object |
Error information |
page_count |
Integer |
Details: Total number of PowerPoint pages. Constraints: N/A Value range: 0-256 Default value: 0 |
pages |
Array of PPTPageInfo objects |
PPT page image. |
Parameter |
Type |
Description |
---|---|---|
page_no |
Integer |
Details: Page number. Constraints: N/A Value range: 1-256 |
file_id |
String |
Details: ID of the image file of a specified page. Constraints: N/A Options: The value contains 1 to 64 characters. Default value: N/A |
page_content |
String |
Details: ID of the image file of a specified page Constraints: N/A Options: The value contains 0 to 2,048 characters. Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
style_id |
String |
Virtual human model style ID. |
duration |
Float |
Animation duration. Value range: 0-32767 Default value: 0 |
auto_analysis |
Boolean |
Indicates whether an action needs to be automatically parsed. Default value: false |
voice_delay |
Float |
Delay duration for playing a voice. Unit: second For example, if the entry animation lasts for 3 seconds and voice_delay is set to 4 seconds, the voice is played from the fourth second on after the entry animation starts. Value range: 0-100 Default value: 0 |
animation_insert_restriction |
String |
Limit on the position where an animation is inserted.
|
Parameter |
Type |
Description |
---|---|---|
components |
Array of SceneComponentInfo objects |
Operable components (such as the screen, light, and camera). |
default_configs |
Map<String,SceneComponentInfo> |
Default scene settings (camera position and initial person position). |
Parameter |
Type |
Description |
---|---|---|
index |
Integer |
Component index. Value range: 1-10 |
component_name |
String |
Component name. |
component_type |
String |
Component type.
|
component_desc |
String |
Component description. |
Parameter |
Type |
Description |
---|---|---|
components |
Array of MaterialComponentInfo objects |
Replaceable material components. |
Parameter |
Type |
Description |
---|---|---|
component_name |
String |
Material component name. |
component_type |
String |
Material component type.
|
component_desc |
String |
Material component description. |
Parameter |
Type |
Description |
---|---|---|
is_action_editable |
Boolean |
Details: Whether the actions of a virtual avatar can be edited. Constraints: N/A Options:
Default value: false |
is_real_background |
Boolean |
Details: Whether it is a real-scene virtual avatar. Constraints: If yes, the background does not need to be changed. Options:
Default value: false |
support_live |
Boolean |
Details: Whether livestreaming is supported. Constraints: N/A Options:
Default value: false |
model_version |
String |
Details: Virtual avatar model version Constraints: N/A Options:
Default value: V2 |
model_resolution |
String |
Details: Virtual avatar model resolution. Constraints: N/A Options:
Default value: 1080P |
device_names |
Array of strings |
Details: Devices for which compilation tasks have been executed. Constraints: Walking virtual avatars can be used only for video production. Options: A maximum of 16 device names are allowed. A device name contains 1 to 64 characters. Default value: false |
is_with_action_library |
Boolean |
Whether the virtual avatar has an atomic action library.
Default value: false |
action_tag_map |
Array of ActionTagInfo objects |
Action tag mapping. |
is_flexus |
Boolean |
Whether it is a Flexus virtual avatar. Default value: false |
Parameter |
Type |
Description |
---|---|---|
action_name_zh |
String |
Atomic action name in Chinese. |
action_name_en |
String |
Atomic action name in English. |
catalog |
String |
Action category name. |
file_name |
String |
Sample video file name. The value contains 1 to 256 characters. |
tag |
String |
Action tag. |
Parameter |
Type |
Description |
---|---|---|
codec |
String |
Details: Image encoding format. Constraints: Automatically extracted. Options: The value contains 0 to 32 characters. Default value: N/A |
width |
Integer |
Details: Image width. Constraints: Automatically extracted. Default value: N/A Value range: 0-8196 |
height |
Integer |
Details: Image height. Constraints: Automatically extracted. Default value: N/A Value range: 0-8196 |
size |
Number |
Details: Image size. Constraints: Automatically extracted. Default value: N/A Value range: 0-9223372036854775807 |
mode |
String |
Details: Image form. Constraints: Automatically extracted. Options:
Default value: N/A |
error_info |
ErrorResponse object |
Error message |
Parameter |
Type |
Description |
---|---|---|
video_codec |
String |
Details: Video encoding format. Constraints: Automatically extracted. Options: The value contains 0 to 32 characters. Default value: N/A |
width |
Integer |
Details: Video image width. Constraints: Automatically extracted. Default value: N/A Value range: 0-8196 |
height |
Integer |
Details: Video height. Constraints: Automatically extracted. Default value: N/A Value range: 0-8196 |
frame_rate |
String |
Details: Video frame rate. Constraints: Automatically extracted. Options: The value contains 0 to 32 characters. Default value: N/A |
video_bit_rate |
Integer |
Details: Average video bitrate, in kbit/s. Constraints: Automatically extracted. Default value: N/A Value range: 0-104857600 |
duration |
Integer |
Details: Duration, in second. Constraints: Automatically extracted. Default value: N/A Value range: 0-86400 |
audio_codec |
String |
Details: Audio encoding format. Constraints: Automatically extracted. Options: The value contains 0 to 32 characters. Default value: N/A |
audio_bit_rate |
Integer |
Details: Average audio bitrate, in kbit/s. Constraints: Automatically extracted. Default value: N/A Value range: 0-16384 |
audio_channels |
Integer |
Details: Number of audio channels. Constraints: Automatically extracted. Default value: N/A Value range: 0-100 |
sample |
Integer |
Details: Sampling rate, in Hz. Constraints: Automatically extracted. Default value: N/A Value range: 0-100000 |
mode |
String |
Details: Horizontal or vertical display. Constraints: Automatically extracted. Options:
Default value: N/A |
video_transcoding_status |
String |
Details: Video transcoding status. Constraints: Automatically filled. Options:
Default value: N/A |
error_info |
ErrorResponse object |
Error message |
Parameter |
Type |
Description |
---|---|---|
duration |
Integer |
Details: Duration, in second. Constraints: Automatically extracted. Default value: N/A Value range: 0-86400 |
audio_codec |
String |
Details: Audio encoding format. Constraints: Automatically extracted. Options: The value contains 0 to 32 characters. Default value: N/A |
audio_bit_rate |
Integer |
Details: Average audio bitrate, in kbit/s. Constraints: Automatically extracted. Default value: N/A Value range: 0-16384 |
audio_channels |
Integer |
Details: Number of audio channels. Constraints: Automatically extracted. Default value: N/A Value range: 0-100 |
sample |
Integer |
Details: Sampling rate, in Hz. Constraints: Automatically extracted. Default value: N/A Value range: 0-100000 |
error_info |
ErrorResponse object |
Error message |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Parameter |
Type |
Description |
---|---|---|
action |
String |
Details: Operation. Constraints: System properties cannot be modified by common users. Options:
Default value: N/A |
key |
String |
Details: System property. Constraints: System properties cannot be modified by common users. Options: Public asset property. Options:
Virtual avatar asset property. Options:
Video translation asset property. Options:
3D virtual human asset attribute. Options:
Default value: N/A |
value |
String |
Details: System attribute value. Constraints: System properties cannot be modified by common users. Options: The value contains 1 to 1,024 characters. Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
file_id |
String |
File ID. |
file_name |
String |
The file name is case-insensitive and can contain 1 to 256 characters. |
file_md5 |
String |
MD5 value of the file content. The value must contain 24 characters. |
file_size |
Long |
Total file size. The value ranges from 1 to 5368709120. Value range: 1-5368709120 |
file_type |
String |
File type (the file name extension is extracted by default). |
asset_file_category |
String |
File category in an asset. Each type of asset has different file categories.
|
download_url |
String |
File download URL, which is valid for 24 hours. |
state |
String |
File status. Options:
|
reason |
String |
Rejection reason. |
file_extra_meta |
FileExtraMeta object |
File data. |
Parameter |
Type |
Description |
---|---|---|
video_transcoding_status |
String |
Video transcoding status.
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
GET https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/digital-assets
Example Responses
Status code: 200
Successful.
{ "count" : 1, "assets" : [ { "asset_id" : "24bad716-87b1-45e5-8912-6102f7693265", "asset_name" : "Culture and tourism 3", "asset_description" : "Background image", "create_time" : "2021-10-30T12:30:35Z", "asset_type" : "IMAGE", "asset_state" : "ACTIVED", "tags" : [ "Culture and tourism" ], "files" : [ { "file_id" : "93769b5a-c8c6-4692-9c95-53933a1f0c93", "file_name" : "Culture and tourism 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" } ] } ] }
Status code: 400
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful. |
400 |
Parameters error, including the error code and its description. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot