All Products
Search
Document Center

Edge Security Acceleration:GetPurgeQuota

Last Updated:Mar 23, 2026

Retrieves the quota and quota usage for different purge types.

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 ID of the Site. You can obtain this ID by calling the ListSites API.

123456789****

Type

string

No

The purge type. Valid values:

  • file (default): File Purge.

  • cachetag: Cache Tag Purge.

  • directory: Directory Purge.

  • ignoreParams: Purge by URL with Parameters Ignored.

  • hostname: Hostname Purge.

  • purgeall: Purge All.

file

Response elements

Element

Type

Description

Example

object

The data returned.

RequestId

string

The unique Request ID.

15C66C7B-671A-4297-9187-2C4477247A74

Quota

string

The total daily quota.

100000

Usage

string

The daily quota usage.

10

Quota30Day

string

The total quota for the 30-day period. A value of 0 indicates that this quota is not configured.

200000

Usage30Day

string

The quota usage within the 30-day period.

20

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Quota": "100000",
  "Usage": "10",
  "Quota30Day": "200000",
  "Usage30Day": "20"
}

Error codes

HTTP status code

Error code

Error message

Description

400 MissingTimeParameter The StartTime and EndTime must be both specified. Please provide both a start time and an end time.
400 InvalidEndTime.Mismatch The specified EndTime is earlier than the StartTime. The end time you entered is earlier than the start time. Please check and try again.
400 DomainNameOverLimit A maximum of 500 domains are supported for each request. Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.
400 InvalidTime The query time cannot exceed the last 3 days. The query time cannot exceed the last 3 days.
400 MissingParameter.ObjectType The ObjectType parameter is required if DomainName or ObjectType is specified. Specify the ObjectType parameter.
400 InvalidStationParameter The specified Station is invalid. The specified node parameter is invalid.
400 TooManyRequests Too many requests.Please try again later. Requests are too frequent, please try again later.
400 InvalidTaskId.Malformed The specified taskId is invalid. The specified task ID is invalid.
400 InvalidParameters.InvalidUrls The specified urls are invalid. The requested URL parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.