Listing Model Groups

Lists model groups. Fuzzy search is supported.

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

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

workspace:modelGroup:list

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:modelGroup:list	List	-	-	-	-

GET /v3/ai-agents/model-groups

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset. The default value is 0.
limit	No	Integer	Page size. The default value is 20.
name	No	String	Group name. Fuzzy match is supported.
status	No	String	Group status. The value can be draft, active, inactive, or deprecated.

None

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
total	Integer	Total quantity.
items	Array of ModelGroupItemVO objects	Model group item.

**Table 3** ModelGroupItemVO
Parameter	Type	Description
id	String	Model group ID.
name	String	Group name.
description	String	Group description.
priority	Integer	Group priority.
default_model_id	String	Default model ID.
provider_count	Integer	Number of associated providers.
resource_count	Integer	Number of associated application objects (agent instances and desktop tags).
create_time	String	Creation time (in ISO 8601 format and UTC time zone).
update_time	String	Update time (in ISO 8601 format and UTC time zone).

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

None

None

Status Code	Description
200	Operation successful.
400	The request cannot be understood by the server due to malformed syntax.
401	Authorization failed.
403	No permissions.

Parent topic: Model Groups

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.

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