Create a shared traffic package
Updated at：2025-10-16
Description
- Shared traffic packages are provided in a prepay model. They take effect immediately upon purchase, and postpaid EIP fees billed by traffic in the same region will be automatically offset until the package is either exhausted or expires.
- The reservationLength field is required and specifies the validity period of the shared traffic package. A numeric input is required, with supported periods being 1 month, 6 months, or 12 months.
- The capacity field is required and defines the capacity of the shared traffic package. For 1-month validity: options include "10 G"/"50 G"/"100 G"/"500 G"/"1 T"/"5 T"/"10 T"/"50 T". For 6-month validity: "60 G"/"300 G"/"600 G"/"3 T"/"6 T"/"30 T"/"60 T"/"300 T". For 12-month validity: "1 T"/"10 T"/"50 T"/"100 T"/"500 T"/"1 P". Choose the capacity based on the corresponding specifications.
- deductPolicy is optional and defines the traffic package deduction policy: FullTimeDurationPackage (full-time) or TimeDurationPackage (off-peak), with FullTimeDurationPackage as the default.
- packageType (optional): Specifies the shared traffic package line type (currently supporting WebOutBytes (dynamic), with WebOutBytes as the default).
Request structure
Plain Text
1POST /v{version}/eiptp?clientToken={clientToken} HTTP/1.1
2Host: eip.bj.baidubce.com
3Authorization: authorization string
4{
5 "reservationLength": reservationLength,
6 "capacity": capacity,
7 "deductPolicy": deductPolicy,
8 "packageType": packageType
9}Request headers
There are no special headers required beyond the 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. |
| clientToken | String | No | Query | Idempotency Token |
| reservationLength | int | Yes | RequestBody | Validity period of the shared traffic package (in months): 1/6/12 |
| capacity | String | Yes | RequestBody | Capacity of the shared traffic package For 1 validity: optional specifications include "10 G"/"50 G"/"100 G"/"500 G"/"1 T"/"5 T"/"10 T"/"50 T"; for 6 validity: "60 G"/"300 G"/"600 G"/"3T"/"6 T"/"30 T"/"60 T"/"300 T"; for 12 validity: "1 T"/"10 T"/"50 T"/"100 T"/"500 T"/"1 P". Select the capacity according to corresponding specifications. |
| deductPolicy | String | No | RequestBody | Shared traffic package billing policies, including "FullTimeDurationPackage" (full-time) or "TimeDurationPackage" (off-peak), defaulted as "FullTimeDurationPackage. |
| packageType | String | No | RequestBody | Internet connection type of the shared traffic package, currently supporting "WebOutBytes" dynamic, defaulted as "WebOutBytes” |
Response Status Code
Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](EIP/API Reference/Error code.md).
Response headers
No special headers beyond common headers.
Response parameters
| Parameter name | Type | Description |
|---|---|---|
| id | String | ID of the shared traffic package |
Request example
Plain Text
1POST /v1/eiptp?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST: eip.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2021-08-17T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4{
5 "reservationLength": 1,
6 "capacity": "10G",
7 "deductPolicy": "FullTimeDurationPackage",
8 "packageType": "WebOutBytes"
9}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Tue, 17 Aug 2021 08:26:53 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7{
8 "id":"tp-87V5cnkwqO"
9}