ListQuotasMinEffectPlan - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the minimum plan edition required for a site plan quota to take effect, that is, the minimum plan edition to which the quota must be upgraded for use.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	No	The site ID. You can call the ListSites operation to obtain the site ID.	123456****
QuotaNames	string	Yes	The plan quota names, separated by commas (,). Valid values: waf:phase:http_anti_scan:actions: WAF scan protection - action enumeration. waf:phase:http_bot:actions: WAF bot management - all action enumeration. waf:phase:http_bot:http_custom_cc_dev:characteristic:fields: WAF bot management - custom device rate limiting statistical object enumeration. waf:phase:http_bot:http_custom_cc_ip:characteristic:fields: WAF bot management - custom IP rate limiting statistical object enumeration. waf:phase:http_bot:match:symbols: WAF bot management - match operator enumeration. waf:phase:http_bot:http_custom_cc:characteristic:fields: WAF bot management - custom session rate limiting statistical object enumeration. waf:phase:http_bot:match:fields: WAF bot management - match field enumeration. waf:phase:http_whitelist:match:symbols: WAF whitelist - match operator enumeration. waf:phase:http_whitelist:match:fields: WAF whitelist - match field enumeration. waf:phase:http_anti_scan:http_directory_traversal:characteristic:fields: WAF scan protection - folder traverse blocking statistical object enumeration. waf:phase:http_anti_scan:http_high_frequency:characteristic:fields: WAF scan protection - high-frequency scan blocking statistical object enumeration. waf:phase:http_anti_scan:match:symbols: WAF scan protection - match operator enumeration. waf:phase:http_anti_scan:match:fields: WAF scan protection - match field enumeration. waf:phase:http_managed:actions: WAF managed rules - action enumeration. waf:phase:http_managed:group:reference:ids: WAF managed rules - referenced rule group enumeration. waf:phase:http_ratelimit:actions: WAF rate limiting - action enumeration. waf:phase:http_ratelimit:ttls: WAF rate limiting - duration enumeration. waf:phase:http_ratelimit:intervals: WAF rate limiting - statistical period. waf:phase:http_ratelimit:http_ratelimit:characteristic:fields: WAF rate limiting - control type rule match characteristic enumeration. waf:phase:http_ratelimit:match:symbols: WAF rate limiting rule phase match operator enumeration. waf:phase:http_ratelimit:match:fields: WAF rate limiting rule phase match field enumeration. waf:phase:http_custom:actions: WAF custom rule phase action enumeration. waf:phase:http_custom:match:symbols: WAF custom rule phase match operator enumeration. waf:phase:http_custom:match:fields: WAF custom rule phase match field. waiting_room\|queuing_method: waiting room - queuing method. origin_rules\|origin_scheme: back-to-origin rule - back-to-origin protocol. origin_rules\|origin_sni: back-to-origin rule - back-to-origin SNI. origin_rules\|origin_host: back-to-origin rule - back-to-origin host. fourlayeracceleration: Layer 4 acceleration. rtlog_service: real-time log feature switch. dashboard_traffic: value-added capability for network traffic analysis. custom_name_server: custom NS name. waf:phase:http_bot:enable: WAF bot management switch. waf:phase:http_whitelist:enable: WAF whitelist switch. instantlog: instant log active or not. waf:phase:http_anti_scan:enable: WAF scan protection switch. waf:phase:http_managed:group:reference:enable: WAF managed rules - referenced rule group configuration switch. waf:phase:http_managed:enable: WAF managed rules switch. waf:phase:http_ratelimit:on_hit:enable: WAF rate limiting - apply to cache-hit requests switch. ddos: DDoS instance. waf:phase:http_ratelimit:enable: WAF rate limiting rule phase switch. waf:phase:http_custom:enable: WAF custom rule phase switch. waf:phase:all:page:reference:enable: WAF custom response page switch. rules_support_regex: whether the DPI engine supports regular expressions. waiting_room_event: waiting room - scheduled event. waiting_room_rule: waiting room - bypass waiting room. waiting_room\|json_response: waiting room - enable JSON response. waiting_room\|disable_session_renewal: waiting room - disable session renewal. origin_rules\|dns_record: back-to-origin rule - DNS record. managed_transforms\|add_client_geolocation_headers: whether the real client IP header is active in transform rules. tiered_cache\|regional_enable: area cache. real_client_ip_header: client IP header.	waf:phase:http_anti_scan:actions
InstanceId	string	No	The plan instance ID. You can call the ListSites operation to obtain the instance ID. You must specify at least one of this parameter and SiteId.	esa-site-aug976vv2u4g

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
Quotas	array<object>	The list of minimum effective plan editions for quotas.
	array<object>	The details of the minimum effective plan edition for a quota.
QuotaName	string	The quota name. Valid values: waf:phase:http_anti_scan:actions: WAF scan protection - action enumeration. waf:phase:http_bot:actions: WAF bot management - all action enumeration. waf:phase:http_bot:http_custom_cc_dev:characteristic:fields: WAF bot management - custom device rate limiting statistical object enumeration. waf:phase:http_bot:http_custom_cc_ip:characteristic:fields: WAF bot management - custom IP rate limiting statistical object enumeration. waf:phase:http_bot:match:symbols: WAF bot management - match operator enumeration. waf:phase:http_bot:http_custom_cc:characteristic:fields: WAF bot management - custom session rate limiting statistical object enumeration. waf:phase:http_bot:match:fields: WAF bot management - match field enumeration. waf:phase:http_whitelist:match:symbols: WAF whitelist - match operator enumeration. waf:phase:http_whitelist:match:fields: WAF whitelist - match field enumeration. waf:phase:http_anti_scan:http_directory_traversal:characteristic:fields: WAF scan protection - folder traverse blocking statistical object enumeration. waf:phase:http_anti_scan:http_high_frequency:characteristic:fields: WAF scan protection - high-frequency scan blocking statistical object enumeration. waf:phase:http_anti_scan:match:symbols: WAF scan protection - match operator enumeration. waf:phase:http_anti_scan:match:fields: WAF scan protection - match field enumeration. waf:phase:http_managed:actions: WAF managed rules - action enumeration. waf:phase:http_managed:group:reference:ids: WAF managed rules - referenced rule group enumeration. waf:phase:http_ratelimit:actions: WAF rate limiting - action enumeration. waf:phase:http_ratelimit:ttls: WAF rate limiting - duration enumeration. waf:phase:http_ratelimit:intervals: WAF rate limiting - statistical period. waf:phase:http_ratelimit:http_ratelimit:characteristic:fields: WAF rate limiting - control type rule match characteristic enumeration. waf:phase:http_ratelimit:match:symbols: WAF rate limiting rule phase match operator enumeration. waf:phase:http_ratelimit:match:fields: WAF rate limiting rule phase match field enumeration. waf:phase:http_custom:actions: WAF custom rule phase action enumeration. waf:phase:http_custom:match:symbols: WAF custom rule phase match operator enumeration. waf:phase:http_custom:match:fields: WAF custom rule phase match field. waitingroom\|wr_queueing_method: waiting room - queuing method. origin_rules\|origin_scheme: back-to-origin rule - back-to-origin protocol. origin_rules\|origin_sni: back-to-origin rule - back-to-origin SNI. origin_rules\|origin_host: back-to-origin rule - back-to-origin host. fourlayeracceleration: Layer 4 acceleration. rtlog_service: real-time log feature switch. dashboard_traffic: value-added capability for network traffic analysis. custom_name_server: custom NS name. waf:phase:http_bot:enable: WAF bot management switch. waf:phase:http_whitelist:enable: WAF whitelist switch. instantlog: instant log active or not. waf:phase:http_anti_scan:enable: WAF scan protection switch. waf:phase:http_managed:group:reference:enable: WAF managed rules - referenced rule group configuration switch. waf:phase:http_managed:enable: WAF managed rules switch. waf:phase:http_ratelimit:on_hit:enable: WAF rate limiting - apply to cache-hit requests switch. ddos: DDoS instance. waf:phase:http_ratelimit:enable: WAF rate limiting rule phase switch. waf:phase:http_custom:enable: WAF custom rule phase switch. waf:phase:all:page:reference:enable: WAF custom response page switch. rules_support_regex: whether the DPI engine supports regular expressions. waitingroom_event: waiting room - scheduled event. waitingroom_rule: waiting room - bypass waiting room. waitingroom\|wr_json_response: waiting room - enable JSON response. waitingroom\|wr_disable_session_renewal: waiting room - disable session renewal. origin_rules\|dns_record: back-to-origin rule - DNS record. managed_transforms\|add_client_geolocation_headers: whether the real client IP header is active in transform rules. tiered_cache\|regional_enable: area cache. real_client_ip_header: client IP header.	waf:phase:http_anti_scan:actions
QuotaValueType	string	The threshold type of the quota. Valid values: value: enumeration type. An enumeration-type quota has multiple enumeration thresholds. For each enumeration threshold, the system indicates whether it is available in the current edition and, if not, the minimum plan edition in which it becomes available. bool: Boolean type. A Boolean-type quota is abstracted into two enumeration thresholds: true and false. To check whether the quota is available in the current plan edition and the minimum available plan edition, you only need to check the quota details for the true enumeration in the quota details list.	value
QuotaValueDetail	array<object>	The list of quota threshold details.
	object	The quota threshold details.
Value	string		quotaValue1
IsEffect	string		true
MinEffectPlan	string		basic

Examples

Success response

JSON format

{
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "Quotas": [
    {
      "QuotaName": "waf:phase:http_anti_scan:actions",
      "QuotaValueType": "value",
      "QuotaValueDetail": [
        {
          "Value": "quotaValue1",
          "IsEffect": "true",
          "MinEffectPlan": "basic"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	QuotaNotExist	The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.	The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	NoPermission	You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.	You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.
403	Site.NotExist	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.
404	UnsupportQuota	Unsupported quota is specified. Check and try again.	Unsupported quota is specified. Check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.