DescribeModelServices

List model services

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
GwClusterId	string	Yes	The ID of the gateway instance.	pg-xxxxxxxxxx
Name	string	No	The name of the model service.	testName
ModelServiceIds	string	No	The IDs of the model services. Separate multiple IDs with a comma (,).	ms-xxx,ms-xxxx
ModelCategory	string	No	The model category.	text
Protocol	string	No	The protocol type. Valid values: openai anthropic bailian: Models from Model Studio. vllm	openai
Status	string	No	The status of the model service.	Enable
PageSize	integer	No	The number of entries per page.	30
PageNumber	integer	No	The page number.	1
RegionId	string	No	The ID of the region.	cn-beijing

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	24A1990B-4F6E-482B-B8CB-75C612******
TotalRecordCount	integer	The total number of records.	2
PageNumber	integer	The page number.	1
PageRecordCount	integer	The number of records on the current page.	30
Items	array<object>	The details of the model services.
	object	A model service object.
ModelServiceId	string	The model service ID.	ms-xxxxxx
Name	string	The model service name.	test
ModelCategory	string	The model category.	text
Protocol	string	The protocol. Valid values: OpenAI Anthropic bailian: Alibaba Cloud Model Studio. vLLM	openai
Status	string	The status of the model service.	Enable
BaseUrl	string	The base URL of the upstream service.	https://xxxxxx
GmtCreated	string	The time when the model service was created.	2026-03-31T14:40:48Z
InputCostPointsPerMillion	string	The cost in points per million input tokens.	10
OutputCostPointsPerMillion	string	The cost in points per million output tokens.	10
RequestCostPoints	string	The cost in points per request.	10
ApiKey	string	The API key for the model service.	xxxx
Vendor	string	The vendor of the model service.	bailian
PageSize	integer	The number of records to return on each page. Valid values: 30 50 100 Default value: 30.	30

Examples

Success response

JSON format

{
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "TotalRecordCount": 2,
  "PageNumber": 1,
  "PageRecordCount": 30,
  "Items": [
    {
      "ModelServiceId": "ms-xxxxxx",
      "Name": "test",
      "ModelCategory": "text",
      "Protocol": "openai",
      "Status": "Enable",
      "BaseUrl": "https://xxxxxx",
      "GmtCreated": "2026-03-31T14:40:48Z",
      "InputCostPointsPerMillion": "10",
      "OutputCostPointsPerMillion": "10",
      "RequestCostPoints": "10",
      "ApiKey": "xxxx",
      "Vendor": "bailian"
    }
  ],
  "PageSize": 30
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.