DescribeRatePlanPriceGap - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the price difference for a plan specification change by calling DescribeRatePlanPriceGap.

Operation description

The plan name and plan code can be obtained from the DescribeRatePlanPrice operation.

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

esa:DescribeRatePlanPriceGap

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The target plan name. You can obtain this value from the DescribeRatePlanPrice operation.	entranceplan
TargetPlanCode	string	No	The code of the target plan for the specification change.	standardplan
OrderType	string	No	The specification change type. Valid values: DOWNGRADE: downgrade. UPGRADE: upgrade. Valid values: UPGRADE : Upgrade.	UPGRADE
TargetPlanName	string	No	The name of the target plan for the specification change.	entranceplan

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	40423A7F-A83D-1E24-B80E-86DD25790759
PriceModel	object	The price information.
Rule	object
RuleList	array<object>	The rule hits.
	object
Name	string	The policy name.	Policy A
RuleDescId	integer	The policy ID.	1
InstanceId	string	The instance ID.	xcdn-91fknmb80f0g
TargetPlanCode	string	The target plan code.	entranceplan
Price	number	The final order price, which is the actual transaction price.	1
Currency	string	The currency. Valid values: JPY: Japanese Yen. USD: US Dollar. CNY: Chinese Yuan.	CNY
TotalPrice	number	The original order price. Original order price = actual transaction price + discount amount.	2
DiscountPrice	number	The discount amount of the order.	1

Examples

Success response

JSON format

{
  "RequestId": "40423A7F-A83D-1E24-B80E-86DD25790759",
  "PriceModel": {
    "Rule": {
      "RuleList": [
        {
          "Name": "Policy A",
          "RuleDescId": 1
        }
      ]
    },
    "InstanceId": "xcdn-91fknmb80f0g",
    "TargetPlanCode": "entranceplan",
    "Price": 1,
    "Currency": "CNY",
    "TotalPrice": 2,
    "DiscountPrice": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalError	An internal exception occurred, please try again later.	An inner exception was triggered. Please try again later.
400	CheckPlanFailed	Invalid plan name or code. Check and try again.	Invalid plan name or code. Check and try again.
400	InvalidSiteICP	The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.	The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.
400	InvalidSiteName	Invalid website name. Check and try again.	Invalid website name. Check and try again.
400	SYSTEM.NoSpecificCodeFailed	Invalid subscription duration. Check and try again.	Invalid subscription duration. Check and try again.
400	InvalidInstance	The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.	The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.
400	InvalidComponent	The order parameters is invalid.	The order parameters is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.