All Products
Search

This Product

    CDN:Throttling functions

    Document Center

    CDN:Throttling functions

    Last Updated:Dec 28, 2023

    This topic describes the syntax, features, parameters, and return values of throttling functions. This topic also provides examples of these functions.

    limit_rate_after

    The following table describes the details of this function.

    Item

    Description

    Syntax

    limit_rate_after(n, unit)

    Description

    Specifies the maximum amount of data transfer before the data transfer rate is throttled. If the upper limit is reached, the data transfer rate is throttled.

    Note

    This function sets the maximum amount of data transfer only for individual requests.

    Parameters

    • n: the maximum amount of data transfer before the data transfer rate is throttled. Data type: integer. If you do not configure the unit parameter, the unit is byte.

    • unit: the unit for measuring the amount of data transfer. Data type: char. This parameter is optional. Valid values for unit: K, M, and G. These values are not case-sensitive.

    Return value

    If the function succeeds, true is returned. Otherwise, false is returned.

    Example

    limit_rate_after(100, 'k')                                                                                                                                                              
limit_rate(1, 'm') 
//Note: Before the amount of data transfer reaches 100 KB, the data transfer rate is not throttled. When the amount of data transfer exceeds 100 KB, the data transfer rate is throttled to 1 MB/s.

    limit_rate

    The following table describes the details of this function.

    Item

    Description

    Syntax

    limit_rate(n, unit)

    Description

    Specifies a value to which the data transfer rate is throttled. By default, the lowest data transfer rate is 50 KB/s. If you specify a data transfer rate that is lower than 50 KB/s, the data transfer rate is throttled to 50 KB/s.

    Note

    This function throttles only individual requests.

    Parameters

    • n: the maximum amount of data transfer before the data transfer rate is throttled. Data type: integer. If you do not configure the unit parameter, the unit is byte/s.

    • unit: the unit for measuring the amount of data transfer. Data type: char. This parameter is optional. Valid values for unit: K, M, and G. These values are not case-sensitive.

    Return value

    If the function succeeds, true is returned. Otherwise, false is returned.

    Example

    limit_rate_after(100, 'k')                                                                                                                                                              
limit_rate(1, 'm') 
//Note: Before the amount of data transfer reaches 100 KB, the data transfer rate is not throttled. When the amount of data transfer exceeds 100 KB, the data transfer rate is throttled to 1 MB/s.