Help Center/ DataArts Fabric/ API Reference/ APIs/ Model Definition/ Checking the Model Version List

Updated on 2025-09-15 GMT+08:00

View PDF

Checking the Model Version List

Function

This API is used to query the model version list. You can call this API to query the model version list. The API supports paginated queries and queries by name or ID. The API returns a list of model versions that meet the filter criteria. This API is synchronous with no accompanying APIs or specific scenarios.

URI

GET /v1/workspaces/{workspace_id}/models/{model_id}/versions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
workspace_id	Yes	String	Definition: Workspace ID. For how to obtain a workspace ID, see [Obtaining a Workspace ID] (dataartsfabric_03_0022.xml). Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
model_id	Yes	String	Definition: Model ID. For how to obtain a model ID, see [Obtaining a Model ID] (dataartsfabric_03_0024.xml). Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition: Offset where a query starts. Constraints: N/A. Range: [0, 1000000000]. Default Value: 0
limit	No	Integer	Definition: Maximum number of records returned on each page. Constraints: N/A. Range: [1, 100]. Default Value: 10.
version_id	No	String	Definition: Model version ID. Constraints: N/A. Range: 32 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
name	No	String	Definition: Model version name. Fuzzy search is supported. Constraints: N/A. Range: 4 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. Default Value: N/A.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition: Tenant token. It is used for API calling authentication. For how to obtain a token, see [Authentication] (dataartsfabric_03_0005.xml). Constraints: N/A. Range: Up to 65,534 characters. Default Value: N/A.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number of versions that meet the filter criteria. Constraints: N/A. Range: [0, 10000]. Default Value: N/A.
versions	Array of ModelVersionInfo objects	Definition: Model version list. Constraints: [0, 10000].

**Table 5** ModelVersionInfo
Parameter	Type	Description
id	String	Definition: Model version ID. Constraints: This ID is automatically generated by the system and cannot be changed. If you enter an ID, the input does not take effect. Range: 32 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
name	String	Definition: Model version name. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, hyphens (-), underscores (_), periods (.), and spaces are allowed. Default Value: N/A.
cap_white_list	Array of strings	Definition: Image package whitelist. Constraints: [0, 100].
description	String	Definition: Description. Constraints: N/A. Range: [0, 1024]. Default Value: N/A.
config	ModelConfig object	Definition: Model configuration. Constraints: N/A. Range: N/A. Default Value: N/A.
create_time	String	Definition: Creation time. Constraints: N/A. Range: N/A. Default Value: N/A.
create_user	User object	Definition: Tenant information, including the account name, account ID, username, and user ID. Constraints: N/A.

**Table 6** ModelConfig
Parameter	Type	Description
llm_model_config	LlmModelConfig object	Definition: LLM configuration. Constraints: N/A.

**Table 7** LlmModelConfig
Parameter	Type	Description
base_model_type	String	Definition: Base model type. Constraints: N/A. Range: For how to obtain a base model type, see [Listing Base Models] (ListBaseModels.xml). Default Value: N/A.
model_path	String	Definition: Model file path. Constraints: Only valid OBS paths are allowed. Range: N/A. Default Value: N/A.
local_model_path	String	Definition: Local model file path. Constraints: Only local model file paths are allowed. Range: N/A. Default Value: N/A.

**Table 8** User
Parameter	Type	Description
domain_name	String	Definition: Account name. Constraints: N/A. Range: 0 to 64 characters. Default Value: N/A.
domain_id	String	Definition: Account ID. Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
user_name	String	Definition: Username. Constraints: N/A. Range: 0 to 64 characters. Default Value: N/A.
user_id	String	Definition: User ID. Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 401

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 408

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 500

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Example Requests

GET https://{endpoint}/v1/workspaces/{workspace_id}/models/{model_id}/versions

Example Responses

Status code: 200

The model version list is queried.

{
  "total" : 1,
  "versions" : [ {
    "id" : "0b5633ba2b904511ad514346f4d23d4b",
    "name" : "name",
    "cap_white_list" : [ "cap1 cap2 ca* cap*" ],
    "description" : "description",
    "config" : {
      "llm_model_config" : {
        "base_model_type" : "string",
        "model_path" : "obs://bucketname/objectdir/modelpath/"
      }
    },
    "create_time" : "2023-05-30T12:24:30.401Z",
    "create_user" : {
      "domain_name" : "string",
      "domain_id" : "0b5633ba2b904511ad514346f4d23d4b",
      "user_name" : "string",
      "user_id" : "0b5633ba2b904511ad514346f4d23d4b"
    }
  } ]
}

Status code: 400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code	Description
200	The model version list is queried.
400	BadRequest
401	Unauthorized
403	Forbidden
404	NotFound
408	Request Time-out
500	InternalServerError

Error Codes

See Error Codes.

Parent topic: Model Definition

Previous topic: Updating Model Information

Next topic: Deleting Unused Model Definitions

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot