DescribeCostRules

Queries cost rules.

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
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100 Default value: 30.	30
GwClusterId	string	Yes	The gateway instance ID.	pg-xxxxxxxx
ModelName	string	No	The model name, such as `gpt-4` or `qwen-turbo`.	qwen3-max
ModelServiceId	string	No	The model service ID.	ms-xxxxxx
RegionId	string	No	The region ID.	cn-beijing

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	24A1990B-4F6E-482B-B8CB-75C612******
TotalRecordCount	integer	The total number of records.	1
PageRecordCount	integer	The number of records on the current page.	30
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned per page.	30
Items	array<object>	A list of cost rules.
	object	A cost rule.
InputCostPointsPerMillion	string	The cost in points per one million input tokens.	0
OutputCostPointsPerMillion	string	The cost in points per one million output tokens.	0
CacheCostPointsPerMillion	string	The cost in points per one million cached tokens.	0
Model	string	The model name.	gpt-4
ModelServiceId	string	The model service ID.	ms-xxxxxxxxx
CostRuleId	string	The cost rule ID.	924d450014e64e88ac6e8486f8e990**
GwClusterId	string	The gateway instance ID.	pg-xxxxxxxxxx
GmtCreated	string	The time when the cost rule was created.	2026-01-04T16:09:29+08:00
GmtModified	string	The time when the cost rule was last updated.	2024-10-16 16:46:20

Examples

Success response

JSON format

{
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "InputCostPointsPerMillion": "0",
      "OutputCostPointsPerMillion": "0",
      "CacheCostPointsPerMillion": "0",
      "Model": "gpt-4",
      "ModelServiceId": "ms-xxxxxxxxx",
      "CostRuleId": "924d450014e64e88ac6e8486f8e990**",
      "GwClusterId": "pg-xxxxxxxxxx",
      "GmtCreated": "2026-01-04T16:09:29+08:00",
      "GmtModified": "2024-10-16 16:46:20\n"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.