View Gateway Bandwidth Limiting Rule
Updated at:2025-10-16
Description
View gateway bandwidth limiting rule list.
Request structure
Text
1GET /v{version}/gateway/limitrule HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
Request headers
No special headers beyond common headers.
Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number, current value is 1. |
| serviceType | String | No | Query | Service type peerconn-peering connections et-dedicated gateway csn-cloud smart networks |
| name | String | No | Query | Fuzzy query by name |
| glrId | String | No | Query | Fuzzy query by rule ID |
| resourceId | String | No | Query | Fuzzy query by resource ID |
| marker | String | No | Query | Marker indicating where to start the query (use the value of glrId) |
| maxKeys | String | No | Query | Page size (default: 1000) |
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| result | List<[GlrItem](VPC/API Reference/Appendix.md#GlrItem)> | List of bandwidth limiting rules |
| marker | String | Mark the starting position of the query. |
| isTruncated | Boolean | true indicates there is more data later, false indicates it is the last page |
| maxKeys | Integer | Maximum number of items included per page |
| nextMarker | String | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
Request example
Text
1GET /v1/gateway/limitrule?serviceType=peerconn&name=pi-3&glrId=&resourceId=&maxKeys= HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1d
Response example
Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "result": [
8 {
9 "glrId": "glr-4hx7it9zefjn",
10 "ipVersion": "4",
11 "name": "fapi-3",
12 "description": "test-createfrom-api-description",
13 "serviceType": "peerconn",
14 "subServiceType": "peerconn",
15 "resourceId": "qpif-yyjnxpqvecvg",
16 "direction": "egress",
17 "cidr": "192.168.0.14/32",
18 "bandwidth": 1,
19 "enable": true,
20 "createdTime": "2024-05-06T12:02:54Z",
21 "updatedTime": "2024-05-06T12:02:54Z"
22 }
23 ],
24 "marker": null,
25 "isTruncated": false,
26 "maxKeys": 1000
27}
