Help Center/ MetaStudio/ API Reference/ Virtual Avatar Livestreaming/ Live Product Management/ Querying Products
Updated on 2024-07-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Products

Function

Queries products.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/products

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

offset

No

Integer

Offset where the query starts.

limit

No

Integer

Number of items displayed on each page.

sort_key

No

String

Sorting field. Currently, only create_time is supported.

sort_dir

No

String

Sorting mode.

  • asc: ascending order

  • desc: descending order

asc is used by default.

create_until

No

String

Filter the records whose creation time is not later than the entered time.

create_since

No

String

Filter the records whose creation time is not earlier than the entered time.

name

No

String

Fuzzy search by name.

tag

No

String

Fuzzy search by tag.

state

No

String

Search by status. Use commas (,) to separate multiple statuses.

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.

X-App-UserId

No

String

Third-party user ID, which does not allow Chinese characters.

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

count

Integer

Total number of product information records

products

Array of ProductDetailInfo objects

Product information list
Table 6 ProductDetailInfo

Parameter

Type

Description

product_id

String

Product ID

name

String

Product name

description

String

Product description

tags

Array of strings

Tag. A single tag contains 16 bytes. Multiple tags are separated by commas (,). A maximum of 50 tags are allowed.

cover

ProductCoverDetailInfo object

Product thumbnail information

text_list

Array of ProductTextInfo objects

Text list

asset_list

Array of ProductMediaDetailInfo objects

Material asset list

create_time

String

Time when a product is created. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z.

update_time

String

Time when a product is updated. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z.

state

String

Product status. Options:

  • ACTIVED: activated

  • UNACTIVED: unactivated

  • BLOCK: frozen and unavailable

  • DELETED: deleted
Table 7 ProductCoverDetailInfo

Parameter

Type

Description

asset_id

String

Asset ID

cover_url

String

Thumbnail image path.

thumbnail_url

String

Thumbnail path.
Table 8 ProductTextInfo

Parameter

Type

Description

title

String

Text title

text

String

Text
Table 9 ProductMediaDetailInfo

Parameter

Type

Description

asset_id

String

Asset ID

asset_type

String

Asset type. Options:

  • IMAGE: image

  • VIDEO: video

  • AUDIO: audio

order

Integer

Asset sequence. If this parameter is not specified or is set to 0, assets are sorted by creation time. The image on top of the list is set as the product thumbnail.

asset_name

String

Asset name.

asset_state

String

Asset status.

cover_url

String

Thumbnail image path.

thumbnail_url

String

Thumbnail path.

main_url

String

Thumbnail path.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/products

Example Responses

Status code: 200

Products queried.

{
  "count" : 1,
  "products" : [ {
    "product_id" : "24bad716-87b1-45e5-8912-6102f7693265",
    "name" : "Meeting",
    "description" : "Meeting",
    "tags" : [ "Huawei" ],
    "create_time" : "2021-09-30T10:43:17Z",
    "update_time" : "2021-10-30T12:30:35Z",
    "state" : "CREATING"
  } ]
}

Status code: 400

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

Status code: 500

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code

Description

200

Products queried.

400

Parameters error, including the error code and its description.

500

Internal service error.

Error Codes

See Error Codes.

Parent Topic: Live Product Management