template limit-policy limit-throughput¶

Enable Throughput Rate Limit

limit-throughput Specification¶

Parameter Value

Type Configuration Resource

Element Name limit-throughput

Element URI /axapi/v3/template/limit-policy/{policy-number}/limit-throughput

Element Attributes limit-throughput_attributes

Partition Visibility shared

Schema limit-throughput schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/template/limit-policy/{policy-number}/limit-throughput	limit-throughput attributes
POST /axapi/v3/template/limit-policy/1/limit-throughput Payload: { "limit-throughput": { "uplink": 1, "uplink-burstsize": 1 } }
Get Object	GET	/axapi/v3/template/limit-policy/{policy-number}/limit-throughput	limit-throughput attributes
GET /axapi/v3/template/limit-policy/1/limit-throughput Reponse: { "limit-throughput": { "uplink": 1, "uplink-burstsize": 1, "uplink-relaxed": 0, "uuid": "8bf20d8c-5115-11ee-b8e9-001fa0083030", "a10-url": "/axapi/v3/template/limit-policy/1/limit-throughput" } }
Modify Object	POST	/axapi/v3/template/limit-policy/{policy-number}/limit-throughput	limit-throughput attributes
Replace Object	PUT	/axapi/v3/template/limit-policy/{policy-number}/limit-throughput	limit-throughput attributes
PUT /axapi/v3/template/limit-policy/1/limit-throughput Payload: { "limit-throughput": { "uplink": 2, "uplink-burstsize": 2 } }
Delete Object	DELETE	/axapi/v3/template/limit-policy/{policy-number}/limit-throughput	limit-throughput attributes
DELETE /axapi/v3/template/limit-policy/1/limit-throughput Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

limit-throughput attributes¶

downlink

Description Downlink Throughput limit (Mega Bits per second)

Type: number

Range: 1-100000

downlink-burstsize

Description Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

Type: number

Range: 1-100000

downlink-relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

total

Description Total Throughput limit (Mega Bits per second)

Type: number

Range: 1-100000

total-burstsize

Description Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

Type: number

Range: 1-100000

total-relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uplink

Description Uplink Throughput limit (Mega Bits per second)

Type: number

Range: 1-100000

uplink-burstsize

Description Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

Type: number

Range: 1-100000

uplink-relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters