ModelRouterQueryClientList-Smart Science and Education Content Platform(SSECP)-阿里云帮助中心

Retrieves a list of clients.

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

aicontent:ModelRouterQueryClientList

list

*All Resource

*

None

Request syntax

GET /api/v1/modelRouter/open/clients HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
pageSize	integer	No	The number of entries to return per page.	10
pageIndex	integer	No	The page number of the results to return. The first page is 1.	1
orderBy	string	No	The field to sort the results by.	resourceId
orderDirection	string	No	The sort direction.	DESC
groupBy	string	No	The field to group the results by.	resourceId
needTotalCount	boolean	No	Specifies whether to return the total count of entries.	true
maxResults	integer	No	The maximum number of results to return.	10
keyword	string	No	The search keyword.	test
status	integer	No	Filters the results by status.	1
nextToken	string	No	The token for the next page of results. Set this to the nextToken value from the previous response. Omit for the first page.	1

Response elements

Element	Type	Description	Example
	object	OpenApiPageResponse<ClientDTO>	{ "success": true, "data": { "total": 1, "page": 1, "pageSize": 10, "list": [{"id": 1, "name": "测试客户"}] }, "requestId": "592A27EF-26D3-1434-98C1-97AD63337852" }
requestId	string	The request ID.	xxxx-xxxx-xxxx-xxxxxxxx
success	boolean	Indicates whether the request was successful.	true
errCode	string	The error code.	UNKNOWN_ERROR
errMessage	string	The error message.	未知错误
httpStatusCode	integer	The HTTP status code.	200
data	array	A wrapper object for the paged response data.	[]
	ClientDTO	A client object.	[]

Examples

Success response

JSON format

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "success": true,
  "errCode": "UNKNOWN_ERROR",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": [
    {
      "id": 1,
      "name": "我的客户",
      "address": "杭州市",
      "contact": "13800138000",
      "main": 0,
      "remark": "备注",
      "clientUuid": "st-xxxx",
      "allowedModels": "1,2,3",
      "deleteTag": 0,
      "gmtCreate": "2024-01-01T00:00:00Z",
      "gmtModified": "2024-01-01T00:00:00Z"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	Server.Internal.UnknownError	The request processing has failed due to some unknown error.
403	B.Permission.DeniedException	鉴权失败或权限不足

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.