ListModelCatalog - List models in Hologres - Hologres - Alibaba Cloud Documentation Center

Lists models.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hologram:ListModelCatalog

list

*All Resource

*

None

Request syntax

GET /api/v1/instances/{instanceId}/listModelCatalog HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID.	hgprecn-cn-i7m2ucpyu005

Request parameters

Parameter	Type	Required	Description	Example
maxResults	integer	No	The number of entries per page. Default value: 20 Maximum value: 100	50
nextToken	string	No	The pagination token. Set this parameter to the value of NextToken that is returned from the previous API call.	uat-assembly-cut-3d-bbig

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	819A7F0F-2951-540F-BD94-6A41ECF0281F
nextToken	string	The pagination token. Set this parameter to the value of NextToken that is returned from the previous API call.	None
maxResults	integer	maxResults	50
modelList	array<object>	The list of models.
	object
modelType	string	The model name.	qwen3.5-plus
taskType	string	The model purpose.	chat/completions
provider	string	The underlying model provider.	bailian
defaultParams	string	The default parameters.	{"timeout": 600, "max_retries": 10, "max_retry_delay": 8, "initial_retry_delay": 0.5}
paramsExample	string	The parameter examples.	{ "extra_body": { "translation_options": { "source_lang": "zh", "domains": "The sentence is from Ali Cloud IT domain. ", "terms": [ { "source": "生物传感器", "target": "biological sensor" }, { "source": "身体健康状况", "target": "health status of the body" } ], "tm_list": [ { "source": "您可以通过如下方式查看集群的内核版本信息:", "target": "You can use one of the following methods to query the engine version of a cluster:" } ] } } }
extra	string	The additional parameters.	{\"deepThink\":false,\"onlineSearch\":true}
serviceDeployRegion	string	The deployment region.	cn-beijing

Examples

Success response

JSON format

{
  "requestId": "819A7F0F-2951-540F-BD94-6A41ECF0281F",
  "nextToken": "None",
  "maxResults": 50,
  "modelList": [
    {
      "modelType": "qwen3.5-plus\n",
      "taskType": "chat/completions",
      "provider": "bailian",
      "defaultParams": "{\"timeout\": 600, \"max_retries\": 10, \"max_retry_delay\": 8, \"initial_retry_delay\": 0.5}",
      "paramsExample": "{\n    \"extra_body\": {\n        \"translation_options\": {\n            \"source_lang\": \"zh\",\n            \"domains\": \"The sentence is from Ali Cloud IT domain. \", \n            \"terms\": [\n                {\n                    \"source\": \"生物传感器\",\n                    \"target\": \"biological sensor\"\n                },\n                {\n                    \"source\": \"身体健康状况\",\n                    \"target\": \"health status of the body\"\n                }\n            ],\n            \"tm_list\": [\n                {\n                    \"source\": \"您可以通过如下方式查看集群的内核版本信息:\",\n                    \"target\": \"You can use one of the following methods to query the engine version of a cluster:\"\n                }\n            ]\n        }\n    }\n}",
      "extra": "{\\\"deepThink\\\":false,\\\"onlineSearch\\\":true}",
      "serviceDeployRegion": "cn-beijing"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.