DescribeModelOperatorUsage-阿里云帮助中心

Retrieves the usage metrics of model operators.

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 parameters

Parameter	Type	Required	Description	Example
Keys	array	No	The list of metrics. Separate multiple metrics with commas (,). Valid values: request_count: the number of requests. success_count: the number of successful requests. error_count: the number of failed requests. success_rate: the request success rate. input_token: the number of input tokens. output_token: the number of output tokens. total_token: the total number of tokens.
	string	No	The metric name.	request_count, success_count
StartTime	string	No	The start time of the query. Specify the time in the YYYY-MM-DDThh:mmZ format (UTC). Note Only metrics within the last 30 days can be queried.	2026-06-01T00:00Z
EndTime	string	No	The end time of the query. Specify the time in the YYYY-MM-DDThh:mmZ format (UTC). Note The end time must be later than the start time, and the interval between the start time and end time cannot exceed 7 days.	2026-06-02T00:00Z
ApiKeyIds	array	No	The list of API key IDs. Separate multiple IDs with commas (,). If this parameter is not specified, all API key IDs under the instance ID are used by default. Note The list can contain up to 50 items.
	integer	No	API KEY ID.	1
ModelNames	array	No	The list of model names. Separate multiple names with commas (,).
	string	No	The model name.	qwen3.6-plus
GroupBy	string	No	The dimension by which to split the series. Separate multiple dimensions with commas (,). The order is not significant. Valid values: model (default): splits by model. api_key: splits by API key. model,api_key: splits by model and API key.	model
Period	integer	No	The time bucket size in seconds. Valid values: 1, 5, 15, 60, 300, and 3600. Note If Period is not specified, the default value is determined by the following rules: Window range ≤ 1 hour: Period = 1. Window range ≤ 1 day: Period = 60. Window range ≤ 7 days: Period = 60. When Period is set to 1, the window must be ≤ 1 day.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
StartTime	string	The start time of the query. The time is in the YYYY-MM-DDThh:mmZ format (UTC).	2026-06-01T00:00Z
EndTime	string	The end time of the query. The time is in the YYYY-MM-DDThh:mmZ format (UTC).	2026-06-02T00:00Z
Period	integer	The actual bucket size used, in seconds.	1
Keys	array<object>	The list of metric values.
	array<object>	The metric value details.
Name	string	The metric name.	request_count
Unit	string	The unit. Valid values: requests tokens %	requests
Series	array<object>	The collection of metric values.
	array<object>	The metric value details after splitting.
Role	string		model
Name	string		qwen3.6-plus
ApiKeyId	integer		1
Values	array<object>
	object
Point	array
	string		["2026-06-01T00:00:00Z","1"]

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "StartTime": "2026-06-01T00:00Z",
  "EndTime": "2026-06-02T00:00Z",
  "Period": 1,
  "Keys": [
    {
      "Name": "request_count",
      "Unit": "requests",
      "Series": [
        {
          "Role": "model",
          "Name": "qwen3.6-plus",
          "ApiKeyId": 1,
          "Values": [
            {
              "Point": [
                "[\"2026-06-01T00:00:00Z\",\"1\"]"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.