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

Billing > Query billing cost breakdown

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

list

*All Resource

*

None

Request syntax

GET /api/v1/modelRouter/open/billing/cost/breakdown HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
startTime	integer	Yes	The start time for the query, specified as a Unix timestamp in seconds.	1700000000
endTime	integer	Yes	The end time for the query, specified as a Unix timestamp in seconds.	1700086400
granularity	string	Yes	The granularity for data aggregation. Valid values: `hourly` and `daily`.	hourly
page	integer	No	The page number. Default: 1.	1
pageSize	integer	No	The number of entries per page. Default: 20. Maximum: 500.	20
modelId	integer	No	The ID of the model to query. If not specified, data for all models is returned.	12
clientId	integer	No	The ID of the client to query. If not specified, data for all clients is returned.	5
modelTypes	string	No	The types of the models to query, separated by commas. For example: `Chat,Embedding`. If not specified, data for all model types is returned.	Chat
maxResults	integer	No	The maximum number of results to return. This parameter is used for pagination along with `nextToken` and is mutually exclusive with `page` and `pageSize`.	20
nextToken	string	No	The pagination token that is used to retrieve the next page of results.	xxxx-xxx-xxxxx

Response elements

Element	Type	Description	Example
	object	The response object.	{ "success": true, "data": {"granularity": "hourly", "total": 100, "page": 1, "page_size": 20, "rows": []}, "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	BillingCostBreakdownRespDTO	The data object containing the billing breakdown. For details, see the response example.	{}
maxResults	integer	The maximum number of results returned.	20
nextToken	string	The pagination token. If this parameter is not empty, pass its value in a subsequent request to retrieve the next page of results.	xxxx-xxx-xxxxx

Examples

Success response

JSON format

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "success": true,
  "errCode": "UNKNOWN_ERROR",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": {
    "granularity": "hourly",
    "page": 1,
    "pageSize": 20,
    "total": 100,
    "columns": [
      {
        "key": "total_calls",
        "label": "调用次数",
        "sortable": true,
        "unit": "次"
      }
    ],
    "rows": [
      {
        "summaryTime": 1700000000,
        "modelId": 1,
        "modelCode": "qwen-plus",
        "modelName": "通义千问-Plus",
        "modelType": "llm",
        "clientId": 0,
        "clientName": "研发部",
        "apiKeyId": 0,
        "apiKeyName": "默认密钥",
        "billingType": "total_amount",
        "payableAmount": 0.000128,
        "dimValues": "{\"billing_version\": \"v1\"}",
        "values": "{\"input_tokens\": 512000, \"output_tokens\": 256000}",
        "tiers": [
          {
            "dimValues": "{\"context_tier\": \"0-32k\"}",
            "values": "{\"input_tokens\": 1000, \"output_tokens\": 500}",
            "payableAmount": 0.05
          }
        ]
      }
    ]
  },
  "maxResults": 20,
  "nextToken": "xxxx-xxx-xxxxx"
}

Error codes

HTTP status code	Error code	Error message
500	Server.Internal.UnknownError	The request processing has failed due to some unknown error.
403	B.Permission.DeniedException	鉴权失败或权限不足
403	B.Permission.OrgNoExistException	组织不存在，请主账号开通权限后再试，或联系管理员

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.