GetResourcePackagePrice - Expenses and Costs - Alibaba Cloud Documentation Center

Queries the price of a resource plan.

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

bss:DescribePrice

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProductCode	string	Yes	The code of service. You can query the service code by calling the QueryProductList operation or viewing Codes of Alibaba Cloud Services.	ossbag
PackageType	string	Yes	The type of the resource plan. The value must be the same as the value of the ProductCode parameter that is returned when you call the DescribeResourcePackageProduct operation.	FPT_ossbag_periodMonthlyAcc_NetworkOut_finance_common
EffectiveDate	string	No	The time when the resource plan takes effect. If you do not specify this parameter, the resource plan immediately takes effect by default. When the OrderType is BUY, resource packs with the EffectiveDate longer than the current time of 6 months are not supported. If the OrderType is UPGRADE, the EffectiveDate must be less than or equal to the actual expiration time of the upgraded instance. Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.	2020-02-10T12:00:00Z
Specification	string	Yes	The specifications of the resource plan.	500
Duration	integer	Yes	The validity period of the resource plan. The value must be the same as the duration of the resource plan specified in the specifications.	6
PricingCycle	string	No	The unit of validity period of the resource plan. Valid values: Month Year	Month
OrderType	string	No	The type of the order. Valid values: BUY: You place the order to purchase an instance. UPGRADE: You place the order to upgrade an instance. RENEW: You place the order to renew an instance. Default value: BUY.	BUY
InstanceId	string	No	The ID of the instance. This parameter is required when the order type is renewal or upgrade.	OSSBAG-cn-0xl0002

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The message returned.	Successful!
RequestId	string	The ID of the request.	BBEF51A3-E933-4F40-A534-C673CBDB9C80
Success	boolean	Indicates whether the request is successful.	true
Data	object	The data returned.
OriginalPrice	number	The original price. Unit: CNY.	1290240
DiscountPrice	number	The discounted amount. Unit: CNY.	215040
Currency	string	The type of the currency.	CNY
TradePrice	number	The price at which the transaction is made. Unit: CNY.	1075200
Promotions	object
Promotion	array<object>	The details of the discount.
	object
Name	string	The description of the discount.	A discount of 17% is offered if you purchase a resource plan for six months.
Id	integer	The ID of the promotion.	1000680914

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "BBEF51A3-E933-4F40-A534-C673CBDB9C80",
  "Success": true,
  "Data": {
    "OriginalPrice": 1290240,
    "DiscountPrice": 215040,
    "Currency": "CNY",
    "TradePrice": 1075200,
    "Promotions": {
      "Promotion": [
        {
          "Name": "A discount of 17% is offered if you purchase a resource plan for six months.\n",
          "Id": 1000680914
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotApplicable	This API is not applicable for caller.
400	NotAuthorized	This API is not authorized for caller.
400	MissingParameter	Absent some mandatory parameter for this request.
400	InvalidParameter	This request contain some invalid parameter
400	InvalidOwner	The specified owner doesn't belong to caller.	Invalid user identity.
400	DurationInvalid	Parameter duration can only be positive integer.
400	ProductNotFound	Product not found.
400	PackageTypeNotFound	No such resource package type found.
400	SpecificationInvalid	Parameter specification can only be positive integer.
400	IdInvalid	Parameter ownerId is invalid.
400	EffectiveDateInvalid	Parameter effectiveDate is invalid.
400	IdMissing	Paramter ownerId is missing.
400	PackageTypeNotSupported	Package type currently is not supported.
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.