QuerySavingsPlansDiscount - Expenses and Costs - Alibaba Cloud Documentation Center

Queries the discount information for savings plans.

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

bssapi:QuerySavingsPlansDiscount

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ModuleCode	string	No	The code of the module.	instance_type
PayMode	string	Yes	The payment mode. Valid values: total: all upfront. half: partial upfront. zero: no upfront.	total
PageSize	integer	No	The number of entries per page.	20
SpnType	string	Yes	The type of the savings plan. Valid values: ecs: compute-optimized. universal: universal.	universal
Locale	string	No	The language of the response.	ZH
Cycle	string	Yes	The query cycle.	1:Year
PageNum	integer	No	The page number.	1
Spec	string	No	The resource type.	ecs.g6
CommodityCode	string	Yes	The commodity code.	ecs
Region	string	No	The region.	cn-hangzhou
SpnCommodityCode	string	No	The commodity code of the savings plan.	savingplan_common_public_cn

Response elements

Parameter	Type	Description	Example
	object	The result of the request.
Message	string	The error message.	This API is not applicable for caller.
RequestId	string	The request ID.	6000EE23-274B-4E07-A697-FF2E999520A4
Data	object	The returned data.
HostId	string	The request IP address.	100.104.180.109
Items	array<object>	The list of discount information.
	object	The discount details.
CommodityName	string	The product details.	Pay-as-you-go Elastic Compute Service (ECS) instance
ModuleName	string	The name of the pricing module.	Instance
SpnType	string	The type of the savings plan.	universal
PayMode	string	The payment mode. total: All upfront half: Partial upfront zero: No upfront	total
Cycle	string	The query cycle.	1:Year
Region	string	The region.	cn-zhangjiakou-na62-a01
RegionCode	string	The ID of the region where the instance resides. For more information, see DescribeDBInstanceAttribute.	cn-hangzhou
Spec	string	The resource type.	ecs.g6
DiscountRate	string	The official discount rate.	0.85
ContractDiscountRate	string	The contract discount rate.	0.85
Code	string	The error code.	PARAM_ERROR
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "Message": "This API is not applicable for caller.",
  "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
  "Data": {
    "HostId": "100.104.180.109",
    "Items": [
      {
        "CommodityName": "Pay-as-you-go Elastic Compute Service (ECS) instance\n",
        "ModuleName": "Instance\n",
        "SpnType": "universal",
        "PayMode": "total",
        "Cycle": "1:Year",
        "Region": "cn-zhangjiakou-na62-a01",
        "RegionCode": "cn-hangzhou",
        "Spec": "ecs.g6",
        "DiscountRate": "0.85",
        "ContractDiscountRate": "0.85"
      }
    ]
  },
  "Code": "PARAM_ERROR",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.