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

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:ModelRouterQueryObservationCharts

get

*All Resource

*

None

Request syntax

GET /api/v1/modelRouter/open/observation/charts HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
clientId	integer	No	The client ID to use as a filter.	1
apiKeyId	integer	No	The API key ID to use as a filter.	1
modelId	integer	No	The model ID to use as a filter.	1
timeRange	string	No	The time range for the query. Valid values are `1h`, `6h`, `24h`, `7d`, and `30d`. This parameter is mutually exclusive with `startTime` and `endTime`.	24h
startTime	string	No	The start time of the custom time range, in ISO 8601 UTC format. If specified, `endTime` must also be provided.	2024-01-01T00:00:00Z
endTime	string	No	The end time of the custom time range, in ISO 8601 UTC format. If specified, `startTime` must also be provided.	2024-01-02T00:00:00Z

Response elements

Element	Type	Description	Example
	object	The response object.	{ "success": true, "data": {"requestCount": 100, "tokenCount": 5000}, "requestId": "592A27EF-26D3-1434-98C1-97AD63337852" }
requestId	string	The unique request ID.	xxxx-xxxx-xxxx-xxxxxxxx
success	boolean	Indicates whether the request was successful.	true
errCode	string	The error code returned if the request fails.	UNKNOWN_ERROR
errMessage	string	The error message returned if the request fails.	未知错误
httpStatusCode	integer	The HTTP status code of the response.	200
data	ObservationChartsDTO	The data returned for the request.	[]

Examples

Success response

JSON format

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "success": true,
  "errCode": "UNKNOWN_ERROR",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": {
    "qpm": [
      {
        "timestamp": "2024-01-01T00:00:00Z",
        "value": "",
        "label": "series1"
      }
    ],
    "tpm": [
      {
        "timestamp": "2024-01-01T00:00:00Z",
        "value": "",
        "label": "series1"
      }
    ],
    "concurrency": [
      {
        "timestamp": "2024-01-01T00:00:00Z",
        "value": "",
        "label": "series1"
      }
    ],
    "callVolume": [],
    "successRate": [
      {
        "timestamp": "2024-01-01T00:00:00Z",
        "value": "",
        "label": "series1"
      }
    ],
    "responseTime": []
  }
}

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.