Help Center/ MetaStudio/ API Reference/ Tenant Management/ Number of expired resources in a statistical period.
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Number of expired resources in a statistical period.

Function

Number of yearly/monthly and one-off resources that are about to expire in a specified period.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/tenants/resources-count

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

business

No

String

Service type. You can enter multiple service types and separate them with commas (,).

  • VOICE_CLONE: voice modeling

  • SYNTHETICS_SOUND: voice synthesis

  • ASSET_MANAGER: asset management

  • MODELING_2D: image modeling

  • LIVE_2D: virtual avatar livestreaming

  • VIDEO_2D: virtual avatar video production

  • CHAT_2D: virtual avatar intelligent interaction

  • BUSINESS_CARD_2D: virtual avatar business card

  • PICTURE_2D: photo-based virtual avatar video

  • MODELING_3D: 3D photo-based modeling

  • VDS_3D: 3D visual control

  • TTSA_3D: 3D speech control

  • FLEXUS_2D: Flexus resources

resource_expire_start_time

No

String

Start time of the resource expiration period. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

resource_expire_end_time

No

String

End time of the resource expiration period. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

Request Parameters

Table 3 Request header 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-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 5 Response body parameters

Parameter

Type

Description

resources_count

Array of ResourcesCount objects

Total number of different resources
Table 6 ResourcesCount

Parameter

Type

Description

business_type

String

Service type. You can enter multiple service types and separate them with commas (,).

  • VOICE_CLONE: voice modeling

  • SYNTHETICS_SOUND: voice synthesis

  • ASSET_MANAGER: asset management

  • MODELING_2D: image modeling

  • LIVE_2D: virtual avatar livestreaming

  • VIDEO_2D: virtual avatar video production

  • CHAT_2D: virtual avatar intelligent interaction

  • BUSINESS_CARD_2D: virtual avatar business card

  • PICTURE_2D: photo-based virtual avatar video

  • MODELING_3D: 3D photo-based modeling

  • VDS_3D: 3D visual control

  • TTSA_3D: 3D speech control

  • FLEXUS_2D: Flexus resources

count

Number

Total number of resources.

Value range:

0~2147483647

charging_mode

String

Billing mode.

  • PERIODIC: yearly/monthly

  • ONE_TIME: one-off billing

  • ON_DEMAND: pay-per-use billing

resource_source

String

Resource source.

  • PURCHASED: purchased

  • SP_ALLOCATED: allocated by the SP

  • ADMIN_ALLOCATED: allocated by the administrator

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

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

Example Responses

Status code: 200

Views tenant information.

{
  "resources_count" : [ {
    "business_type" : "LIVE_2D",
    "count" : 1,
    "charging_mode" : "ONE_TIME",
    "resource_source" : "SP_ALLOCATED"
  } ]
}

Status code: 400

Parameters error, including the error code and its description.

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

Status Codes

Status Code

Description

200

Views tenant information.

400

Parameters error, including the error code and its description.

Error Codes

See Error Codes.

Parent Topic: Tenant Management