DescribeRatePlanPrice - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries plan pricing, including plan type and status.

Operation description

The purchase period is measured in months.

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:DescribeRatePlanPrice

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Period	integer	No	The purchase duration, in months.	1
PlanName	string	No	The plan name.	basic
Amount	integer	No	The number of plans.	1

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	50423A7F-A83D-1E24-B80E-86DD25790759
PriceModel	object	The pricing information.
RatePlan	object
PlanPriceList	array<object>	The plan price information.
	object
PlanName	string	The plan name.	basic
PlanType	string	The plan type. Valid values: normal: Fixed plan. enterprise: Enterprise plan.	normal
PlanStatus	string	The plan status. Valid values: uncustomed: Not customized. upgrading: Upgrading. unsaled: Not purchased. saled: Purchased.	unsaled
Currency	string	The currency. Valid values: JPY: Japanese yen. USD: US dollar. CNY: Chinese yuan.	CNY
TotalPrice	number	The original order price, equal to the sum of the transaction price and discount amount.	2
DiscountPrice	number	The order discount amount.	1
Price	number	The final order price.	1
Coverages	string	The acceleration regions supported by the plan.	overseas,global,domestic
Position	integer	The plan priority.	1
ChargeType	string	The billing method. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go.	PREPAY
PlanTraffic	string	The plan capacity.	1000
EdgeCompute	string	Edge computing.	er_on
EdgeWaf	string	Edge WAF.	waf_off
DcdnPlan	string	The plan edition.	basicplan
AccelerateType	string	The acceleration type.	smartrouting_off
EdgeDdos7Layer	string	Layer 7 edge DDoS.	ddos_off
Layer4Traffic	string	The capacity for Layer 4 acceleration.	1000
EdgeDdos4Layer	string	Layer 4 edge DDoS.	ddos_off
CrossborderTraffic	string	China network optimization.	1000
EdgeLb7Layer	string	Layer 7 load balancing.	lb_off
EdgeLb4Layer	string	Layer 4 load balancing.	lb_off
Layer4TrafficIntl	string	The capacity for Layer 4 acceleration outside the Chinese mainland.	1000
EdgeDdos4LayerIntl	string	Layer 4 edge DDoS outside the Chinese mainland.	ddos_off
EdgeLb4LayerIntl	string	Layer 4 load balancing outside the Chinese mainland.	lb_off
EdgeDdosInstanceCn	string	The DDoS instance in the Chinese mainland.	cn_300
EdgeDdosInstanceIntl	string	The DDoS instance outside the Chinese mainland.	overseas_300
EdgeWafInstance	string	The WAF instance.	enterprise_bot
Rule	object
RuleList	array<object>	The matched policy.
	object
Name	string	The policy name.	Policy A
RuleDescId	integer	The policy ID.	1

Examples

Success response

JSON format

{
  "RequestId": "50423A7F-A83D-1E24-B80E-86DD25790759",
  "PriceModel": {
    "RatePlan": {
      "PlanPriceList": [
        {
          "PlanName": "basic",
          "PlanType": "normal",
          "PlanStatus": "unsaled",
          "Currency": "CNY",
          "TotalPrice": 2,
          "DiscountPrice": 1,
          "Price": 1,
          "Coverages": "overseas,global,domestic",
          "Position": 1,
          "ChargeType": "PREPAY",
          "PlanTraffic": "1000",
          "EdgeCompute": "er_on",
          "EdgeWaf": "waf_off",
          "DcdnPlan": "basicplan",
          "AccelerateType": "smartrouting_off",
          "EdgeDdos7Layer": "ddos_off",
          "Layer4Traffic": "1000",
          "EdgeDdos4Layer": "ddos_off",
          "CrossborderTraffic": "1000",
          "EdgeLb7Layer": "lb_off",
          "EdgeLb4Layer": "lb_off",
          "Layer4TrafficIntl": "1000",
          "EdgeDdos4LayerIntl": "ddos_off",
          "EdgeLb4LayerIntl": "lb_off",
          "EdgeDdosInstanceCn": "cn_300",
          "EdgeDdosInstanceIntl": "overseas_300",
          "EdgeWafInstance": "enterprise_bot"
        }
      ]
    },
    "Rule": {
      "RuleList": [
        {
          "Name": "Policy A",
          "RuleDescId": 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.
400	EnterpriseAmountErr	Enterprise plans do not support bulk purchase.	Enterprise plans do not support bulk purchase.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.