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

查看租户资源列表

功能介绍

查看租户资源列表。

按需套餐包用量本接口无法查询,需要调用CBC接口查询。按需套餐包用量查询查询资源包信息

各种资源的计费方式请参考计费说明

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/tenants/resources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示的条目数量。

取值范围:

1-100

默认取值:

10

offset

Integer

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

取值范围:

0-2147483647

默认取值:

0

resource

String

资源类型。可填多个,用","分隔。详见资源类型

business

String

业务类型。可填多个,用","分隔。

  • VOICE_CLONE:声音制作

  • SYNTHETICS_SOUND:声音合成

  • ASSET_MANAGER:资产管理

  • MODELING_2D:形象制作

  • LIVE_2D:分身数字人视频直播

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

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

  • BUSINESS_CARD_2D:分身数字人名片

  • PICTURE_2D:照片数字人视频

  • MODELING_3D:3D照片建模

  • VDS_3D:3D视觉驱动

  • TTSA_3D:3D语音驱动

  • FLEXUS_2D:FLEXUS版本资源

resource_source

String

资源来源,可填多个

例如:PURCHASED,ADMIN_ALLOCATED,将返回商用资源与管理员分配资源。

  • PURCHASED: 用户购买的资源

  • SP_ALLOCATED: SP分配的资源

  • ADMIN_ALLOCATED: 系统管理员分配的资源

resource_id

String

资源id。

order_id

String

订单id。

charging_mode

String

计费类型。

  • PERIODIC: 包周期

  • ONE_TIME:一次性

  • ON_DEMAND:按需 计费模式。

resource_expire_start_time

String

资源过期时间段 开始时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"

resource_expire_end_time

String

资源过期时间段 结束时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"

sub_resource

String

子资源类型。当前只有flexus套餐包存在该字段

  • voice_clone_flexus: 语音克隆Flexus版

  • modeling_count_2d_model_flexus: 分身数字人形象制作Flexus版

  • video_time_flexus_2d_model: 分身数字人Flexus版本视频制作

请求参数

表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信息。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表5 响应Body参数

参数

参数类型

描述

resources

Array of ResourceItemInfo objects

资源用量列表

count

Number

资源总数。

取值范围:

0-2147483647

表6 ResourceItemInfo

参数

参数类型

描述

resource_id

String

资源ID。

order_id

String

cloudServiceId的订单id。

云服务购买清单等场景必填(purchaseMode取值为3、4),每个CloudService生成一个订单;此场景如果为空,则报错。

其他场景,为空。

resource_expire_time

String

资源截止时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"

resource_type

String

资源类型。详见资源类型

business_type

String

业务类型。

  • VOICE_CLONE:声音制作

  • SYNTHETICS_SOUND:声音合成

  • ASSET_MANAGER:资产管理

  • MODELING_2D:形象制作

  • LIVE_2D:分身数字人视频直播

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

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

  • BUSINESS_CARD_2D:分身数字人名片

  • PICTURE_2D:照片数字人视频

  • MODELING_3D:3D照片建模

  • VDS_3D:3D视觉驱动

  • TTSA_3D:3D语音驱动

  • FLEXUS_2D:flexus版本资源

sub_resource_type

String

子资源类型。当前只有flexus套餐包存在该字段

  • voice_clone_flexus: 语音克隆Flexus版

  • modeling_count_2d_model_flexus: 分身数字人形象制作Flexus版

  • video_time_flexus_2d_model: 分身数字人Flexus版本视频制作

is_sub_resource

Boolean

是否子资源。子资源描述的是子资源的数量和单位

默认取值:

false

charging_mode

String

计费类型。

  • PERIODIC: 包周期

  • ONE_TIME:一次性

  • ON_DEMAND:按需

resource_source

String

资源来源。

  • PURCHASED: 购买

  • SP_ALLOCATED:SP分配

  • ADMIN_ALLOCATED:系统管理员分配

amount

Number

总量

取值范围:

0-1000000

usage

Number

使用量

取值范围:

0-1000000

unit

String

单位。

  • NUM:个数(形象/声音)

  • MIN:分钟(视频制作)

  • HOUR:小时 (直播)

  • CHANNEL:路(直播/交互)

  • GB:GB(资产管理)

  • MILLION_WORDS:百万字

  • TEN_THOUSAND_WORDS:万字

  • TIME:次

状态码: 400

表7 响应Body参数

参数

参数类型

描述

BadRequest

AnyType

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

请求示例

GET https://{endpoint}/v1/f488337c31c8e4622f1590735b134c65/tenants/resources

响应示例

状态码: 200

查看租户信息

{
  "resources" : [ {
    "resource_id" : "f488337c31c8e4622f1590735b134c65",
    "resource_type" : "Interaction.basic.channel",
    "business_type" : "LIVE_2D",
    "order_id" : "ed4553db2cf949fca7eeb327a276bdbd",
    "resource_expire_time" : "2021-01-10T08:43:17Z",
    "charging_mode" : "ONE_TIME",
    "amount" : 1,
    "unit" : "CHANNEL"
  } ],
  "count" : 1
}

状态码: 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 ListTenantResourcesSolution {

    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();
        ListTenantResourcesRequest request = new ListTenantResourcesRequest();
        try {
            ListTenantResourcesResponse response = client.listTenantResources(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 = ListTenantResourcesRequest()
        response = client.list_tenant_resources(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.ListTenantResourcesRequest{}
	response, err := client.ListTenantResources(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查看租户信息

400

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

错误码

请参见错误码

相关文档