All Products
Search

This Product

    BSS OpenAPI:GetResourcePackagePrice

    Document Center

    BSS OpenAPI:GetResourcePackagePrice

    Last Updated:Apr 10, 2024

    Queries the price of a resource plan.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    bss:DescribePriceREAD
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ProductCodestringYes

    The code of service. You can query the service code by calling the QueryProductList operation or viewing Codes of Alibaba Cloud Services.

    		ossbag
    PackageTypestringYes

    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
    EffectiveDatestringNo

    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
    SpecificationstringYes

    The specifications of the resource plan.

    		500
    DurationintegerYes

    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
    PricingCyclestringNo

    The unit of validity period of the resource plan. Valid values:

    • Month
    • Year
    		Month
    OrderTypestringNo

    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
    InstanceIdstringNo

    The ID of the instance. This parameter is required when the order type is renewal or upgrade.

    		OSSBAG-cn-0xl0002

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The status code.

    		Success
    Messagestring

    The message returned.

    		Successful!
    RequestIdstring

    The ID of the request.

    		BBEF51A3-E933-4F40-A534-C673CBDB9C80
    Successboolean

    Indicates whether the request is successful.

    		true
    Dataobject

    The data returned.

    OriginalPricefloat

    The original price. Unit: CNY.

    		1290240
    DiscountPricefloat

    The discounted amount. Unit: CNY.

    		215040
    Currencystring

    The type of the currency.

    		CNY
    TradePricefloat

    The price at which the transaction is made. Unit: CNY.

    		1075200
    Promotionsobject []

    The details of the discount.

    Namestring

    The description of the discount.

    		A discount of 17% is offered if you purchase a resource plan for six months.
    Idlong

    The ID of the promotion.

    		1000680914

    Examples

    Sample success responses

    JSONformat

    {
  "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 codeError codeError messageDescription
    400NotApplicableThis API is not applicable for caller.-
    400NotAuthorizedThis API is not authorized for caller.-
    400MissingParameterAbsent some mandatory parameter for this request.-
    400InvalidParameterThis request contain some invalid parameter-
    400InvalidOwnerThe specified owner doesn't belong to caller.Invalid user identity.
    400DurationInvalidParameter duration can only be positive integer.-
    400ProductNotFoundProduct not found.-
    400PackageTypeNotFoundNo such resource package type found.-
    400SpecificationInvalidParameter specification can only be positive integer.-
    400IdInvalidParameter ownerId is invalid.-
    400EffectiveDateInvalidParameter effectiveDate is invalid.-
    400IdMissingParamter ownerId is missing.-
    400PackageTypeNotSupportedPackage type currently is not supported.-
    500InternalErrorThe request processing has failed due to some unknown error.-

    For a list of error codes, visit the Service error codes.