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

查询资产概要

功能介绍

该接口用于查询媒体资产库中指定的多个资产的概要信息。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/digital-assets/summarys

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表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')。

表3 请求Body参数

参数

是否必选

参数类型

描述

asset_ids

Array of strings

需要查询的资产ID。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表5 响应Body参数

参数

参数类型

描述

asset_list

Array of DigitalAssetSummary objects

资产列表。

表6 DigitalAssetSummary

参数

参数类型

描述

asset_id

String

资产ID。

asset_name

String

资产名称。

asset_state

String

资产状态。

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

  • FAILED:主文件上传失败

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

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

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

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

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

  • WAITING_DELETE:资产将被下线

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: 普通模型

cover_url

String

封面图片路径。

thumbnail_url

String

缩略图路径。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

BadRequest

AnyType

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

请求示例

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

{
  "asset_ids" : [ "8cb2f48a2cb006154794741933421100", "e2ba8314ebaab34d368711d118fcecba" ]
}

响应示例

状态码: 200

成功。

{
  "asset_list" : [ {
    "asset_id" : "93769b5a-c8c6-4692-9c95-53933a1f0c93",
    "asset_name" : "男教师",
    "asset_type" : "HUMAN_MODEL",
    "cover_url" : "https://{endpoint}:443/05a8ae5925000fb72f83c0091083231a/ca40212e1cdb64ab5f74446bcddb8eb9/model/image/6dd0c018-7b8e-46aa-8a45-3075c161c500.png?AccessKeyId=F8DE4LGO7EOYY0CM9ERJ&Expires=1657527524&Signature=BWgSQpc4lMFFrtj2ae67fw679%2Bc%3D"
  } ]
}

状态码: 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
48
49
50
51
52
53
54
55
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.*;

import java.util.List;
import java.util.ArrayList;

public class ListAssetSummarySolution {

    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();
        ListAssetSummaryRequest request = new ListAssetSummaryRequest();
        ListAssetSummarysReq body = new ListAssetSummarysReq();
        List<String> listbodyAssetIds = new ArrayList<>();
        listbodyAssetIds.add("8cb2f48a2cb006154794741933421100");
        listbodyAssetIds.add("e2ba8314ebaab34d368711d118fcecba");
        body.withAssetIds(listbodyAssetIds);
        request.withBody(body);
        try {
            ListAssetSummaryResponse response = client.listAssetSummary(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
32
33
34
35
36
37
38
# 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 = ListAssetSummaryRequest()
        listAssetIdsbody = [
            "8cb2f48a2cb006154794741933421100",
            "e2ba8314ebaab34d368711d118fcecba"
        ]
        request.body = ListAssetSummarysReq(
            asset_ids=listAssetIdsbody
        )
        response = client.list_asset_summary(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
38
39
40
41
42
43
44
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.ListAssetSummaryRequest{}
	var listAssetIdsbody = []string{
        "8cb2f48a2cb006154794741933421100",
	    "e2ba8314ebaab34d368711d118fcecba",
    }
	request.Body = &model.ListAssetSummarysReq{
		AssetIds: listAssetIdsbody,
	}
	response, err := client.ListAssetSummary(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功。

400

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

错误码

请参见错误码

相关文档