Help Center/ ModelArts/ API Reference/ Asset Center/ Querying the Asset List
Updated on 2026-11-12 GMT+08:00

Querying the Asset List

Function

This API is used to query the asset list of a specified project on ModelArts.

It is used when you need to view, search for, and manage assets in the asset center. Before using this API, ensure that you have the access permission. The platform returns the list and total number of assets that meet the specified search criteria. If the request parameter format is incorrect or you do not have the required permissions, the API returns an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    modelarts:asset:listAssets

    List

    workspace *

    g:EnterpriseProjectId

    -

    -

URI

GET /v2/{project_id}/assets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: Huawei Cloud project ID. To obtain a project ID, go to the ModelArts Studio console, press F12 to access the developer tool, refresh the page, find the /rest/me API in the Network tab, and then locate the project_id field in the response of the API.

Constraints: The value can contain 1 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Range: N/A

Default Value: N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

sort_dir

No

String

Definition: Sorting order.

Constraints: N/A

Range:

  • ASC: ascending order

  • DESC: descending order

Default Value: DESC

sort_key

No

String

Definition: Sorting field.

Constraints: N/A

Range

  • created_at: creation time

  • updated_at: update time

Default Value: created_at

offset

No

Integer

Definition: Start offset of the query. The value must be a number.

Constraints: N/A

Range: 0 to 100,000,000

Default Value: 0

limit

No

Integer

Definition: Maximum number of records that can be queried at a time. The value must be a number.

Constraints: N/A

Range: 1 to 1,000

Default Value: 100

workspace_id

No

String

Definition: Workspace ID. To obtain the value, click the target project name on the platform, and check the project settings page.

Constraints: The value can contain 1 to 32 characters. Only letters and digits are allowed.

Range: N/A

Default Value: N/A

asset_name

No

String

Definition: Asset name. Only letters, digits, hyphens (-), underscores (_), periods (.), and spaces are allowed.

Constraints: The value can contain 1 to 128 characters.

Range: N/A

Default Value: N/A

asset_type

No

Array of strings

Definition: Asset type.

Constraints: The options are as follows:

  • MODEL

  • TEMPLATE

  • DATASET

  • WORKFLOW

  • IMAGE

  • ALGORITHM

  • DATASET_TEMPLATE

  • DATA_OPERATOR

Default value: N/A

asset_source

No

String

Definition: Asset source.

Constraints: N/A

Range

  • Preset

  • Publish

  • Import

Default Value: N/A

asset_source_type

No

String

Definition: User asset source.

Constraints: N/A

Range: preset_train (fine-tuning), custom_train (custom training), and AgenticRL (reinforcement learning)

Default Value: N/A

asset_code

No

String

Definition: Asset code.

Constraints: The value can contain 1 to 60 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

Range: N/A

Default Value: N/A

asset_version

No

String

Definition: Asset version.

Constraints: The value must be a number or in the format of x.y.z, where x, y, and z are all numbers.

Range: N/A

Default Value: N/A

asset_group_id

No

String

Definition: ID of the asset group to which an asset belongs. If this parameter is specified, all versions in the same asset library are filtered. If this parameter is not specified, major versions in all asset libraries are filtered.

Constraints: The value can contain 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Range: N/A

Default Value: N/A

filter_all_version

No

Boolean

Definition: Whether to filter all versions.

Constraints: N/A

Range: N/A

Default Value: N/A

support_actions

No

Array of strings

Definition: List of operations supported by the asset, for example, SFT (supervised fine-tuning), LORA (LoRA fine-tuning), ONLINE-DEPLOY (real-time deployment), and AgenticRL (reinforcement learning).

Constraints: N/A

Range: N/A

Default Value: N/A

tag

No

Array of strings

Definition: Tag used for asset retrieval. The condition varies depending on the asset type.

  • To match a key with a single value, use the format key=value.

  • To match a key with any of multiple values, use the format key=value1|value2|value3.

  • To match multiple conditions at the same time, use the format key1=value1,key2=value2.

  • To implement fuzzy match, use the format key1%=value2 (right match) or key2=%value2 (left match).

Constraints: N/A

is_mine

No

Boolean

Definition: Whether to filter user-created assets. The value is of the Boolean type. The value true indicates that user-created assets are queried. The value false indicates that all assets are queried.

Constraints: N/A

Range: N/A

Default Value: N/A

with_actions

No

Boolean

Definition: Whether the list query contains an action.

Constraints: N/A

Range: N/A

Default Value: N/A

asset_series

No

String

Definition: Asset brand, for example, DeepSeek, Qwen, Wan, GPT, Llama, GLM, ERNIE, Mistral, Kimi, and others.

Constraints: N/A

Range: The value can contain 0 to 40 characters.

Default Value: N/A

asset_capabilities

No

Array of strings

Definition: Asset capabilities, represented as a list of free-form text strings (not a strict enumeration). The following convention values are recommended: TextGeneration, ImageUnderstanding, ImageGeneration, VideoGeneration, AgenticRL, or Other.

Constraints: 0 to 40 characters.

asset_scenes

No

Array of strings

Definition: Asset scenario, for example, DeepThinking.

Constraints: N/A

root_asset_id

No

String

Definition: Root asset ID.

Constraints: The value can contain 1 to 36 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Range: N/A

Default Value: N/A

parent_asset_id

No

String

Definition: Parent asset ID.

Constraints: The value can contain 1 to 36 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Range: N/A

Default Value: N/A

is_deleted

No

Boolean

Definition: Whether to return soft-deleted assets.

Constraints: N/A

Range: N/A

Default Value: false

asset_ids

No

Array of strings

Definition: Asset ID.

Constraints: 0 to 100 characters.

tag_mode

No

String

Definition: Tag combination mode.

Constraints: N/A

Range: and or or

Default Value: and

dataset_usage

No

String

Definition: Dataset usage. The value can be GENERAL or EVAL (evaluation set).

Constraints: The value can contain 1 to 40 characters.

Range: N/A

Default Value: N/A

status

No

String

Definition: Asset status.

Constraints: N/A

Range

  • online

  • offline

  • waiting

Default Value: N/A

dataset_file_formats

No

Array of strings

Definition: Dataset storage format, for example, JSONL, TXT, MOBI, EPUB, DOCX, or PDF.

Constraints: N/A

dataset_type

No

String

Definition: Dataset modality category, such as audio, images, or video.

Constraints: The value can contain 1 to 40 characters.

Range: N/A

Default Value: N/A

dataset_sub_type

No

String

Definition: Dataset modal segmentation value, for example, semantic segmentation.

Constraints: The value can contain 1 to 40 characters.

Range: N/A

Default Value: N/A

dataset_schema_format

No

String

Definition: Dataset logic specification, for example, Pangu format.

Constraints: The value can contain 1 to 40 characters.

Range: N/A

Default Value: N/A

creator

No

String

Definition: Asset creator.

Constraints: The value can contain 1 to 128 characters.

Range: N/A

Default Value: N/A

data_source_id

No

String

Definition: Data source ID.

Constraints: The value can contain 1 to 40 characters.

Range: N/A

Default Value: N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition: User token. During API authentication using a token, the token is added to requests to get permissions for calling the API. To obtain the token, call /v3/auth/tokens of IAM. The value of X-Subject-Token in the response header is the token.

Constraints: N/A

Range: N/A

Default Value: N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Definition: Total number of assets that meet the filter criteria.

Range: N/A

data

Array of AssetDetail objects

Definition: Tree node list and relationships.

Table 5 AssetDetail

Parameter

Type

Description

asset_id

String

Definition: Asset ID.

Range: N/A

parent_asset_id

String

Definition: Parent asset ID.

Range: N/A

root_asset_id

String

Definition: Root asset ID.

Range: N/A

api_version

String

Definition: Asset API version.

Range: v1 or v2

asset_name

String

Definition: Asset name.

Range: N/A

asset_group_id

String

Definition: ID of the asset group to which the asset is to be added.

Range: The value can contain 0 to 36 characters. It must be an existing group ID.

workspace_id

String

Definition: Workspace ID. To obtain the value, click the target project name on the platform, and check the project settings page.

Range: The value can contain 1 to 32 characters. Only letters and digits are allowed.

asset_type

String

Definition: Asset type.

Range

  • TEMPLATE

  • DATASET

  • WORKFLOW

  • IMAGE

  • ALGORITHM

  • MODEL

  • DATASET_TEMPLATE

sub_asset_type

String

Definition: Asset subtype.

Range: N/A

asset_desc

String

Definition: Asset description.

Range: The value can contain 0 to 256 characters.

asset_code

String

Definition: Asset code.

Range: The value can contain 1 to 60 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

asset_version

String

Definition: Asset version.

Range: The value must be a number or in the format of x.y.z, where x, y, and z are numbers.

tags

map<string, object>

Definition: Asset tag.

Range: N/A

support_actions

AnyType

Definition: List of operations supported by the asset, for example, SFT (supervised fine-tuning), LORA (LoRA fine-tuning), ONLINE-DEPLOY (real-time deployment), and AgenticRL (reinforcement learning).

asset_location

String

Definition: Address for storing the asset file. The value can be an OBS URL or a relative path.

Range: The value can contain 0 to 1,024 characters.

actions

Array of AssetActionRsp objects

Definition: Supported operation details of an asset.

status

String

Definition: Asset status.

Range

  • online

  • offline

  • waiting

dataset_usage

String

Definition: Dataset usage.

Range: The value can contain 1 to 40 characters.

dataset_file_formats

Array of strings

Definition: Dataset storage format, for example, JSONL, TXT, MOBI, EPUB, DOCX, or PDF.

dataset_type

String

Definition: Dataset modality category, such as audio, images, or video.

Range: 1 to 40 characters.

dataset_sub_type

String

Definition: Dataset modal segmentation value, for example, semantic segmentation.

Range: The value can contain 1 to 40 characters.

dataset_schema_format

String

Definition: Dataset logic specification, for example, Pangu format.

Range: The value can contain 1 to 40 characters.

Table 6 AssetActionRsp

Parameter

Type

Description

action_type

String

Definition: Asset action type.

Range: N/A

action_dir

String

Definition: Address of the asset action configuration file.

Range: N/A

Example Requests

https://{endpoint}/v2/{project_id}/assets

Example Responses

Status code: 200

{
  "total_count" : 100000000,
  "data" : [ {
    "asset_name" : "Pangu-AIKits-ImageSearch-Large-Tagging",
    "asset_desc" : "Pangu-AI Kits-ImageSearch-Large-Tagging models are available on ModelArts Studio for the first time.",
    "asset_version" : "0.1.7",
    "asset_location" : "Pangu-AIKits-ImageSearch-Large-Tagging/0.1.7/models",
    "asset_type" : "ImageSearch",
    "sub_asset_type" : "",
    "asset_code" : "Pangu-AIKits-ImageSearch-Large-Tagging"
  }, {
    "asset_name" : "Pangu-AIKits-ImageSearch-Large-Tagging",
    "asset_version" : "0.1.7",
    "asset_location" : "Pangu-AIKits-ImageSearch-Large-Tagging/0.1.7/models",
    "asset_type" : "ImageSearch",
    "sub_asset_type" : "",
    "asset_code" : "Pangu-AIKits-ImageSearch-Large-Tagging"
  }, {
    "asset_name" : "Pangu-AIKits-ImageSearch-Large-Tagging",
    "asset_desc" : "Pangu-AI Kits-ImageSearch-Large-Tagging models are available on ModelArts Studio for the first time.",
    "asset_version" : "0.1.7",
    "asset_location" : "Pangu-AIKits-ImageSearch-Large-Tagging/0.1.7/models",
    "asset_type" : "ImageSearch",
    "sub_asset_type" : "",
    "asset_code" : "Pangu-AIKits-ImageSearch-Large-Tagging"
  } ]
}

Status Codes

Status Code

Description

200

Asset list is returned.

Error Codes

See Error Codes.