ModifyCrossRegionBandwidth

1. API Description

This API is used to modify the configurations of the cross-region bandwidth.

Note

  • If the network billing model is ByBandwidth, the new bandwidth cap must be different from the original one.

  • If the network billing model is ByInstanceBandwidth95, one of the bandwidth commitment and the burst bandwidth must be modified at least. If the burst bandwidth is not specified, it is not changed by default.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

crossRegionBandwidthId

Yes

String

Cross-region bandwidth ID.

bandwidth

Yes

Integer

Bandwidth cap.

bandwidthCap

No

Integer

Burst bandwidth.

Unit: Mbps.

Available range: [1, +).

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

1. For a cross-region bandwidth with the network billing model of ByBandwidth, modify the bandwidth cap to 500 Mbps.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyCrossRegionBandwidth
<Common Request Params>

Request:
{
  "crossRegionBandwidthId": "<your cross id>",
  "bandwidth": 500
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

2. For a cross-region bandwidth with the network billing model of ByInstanceBandwidth95, modify the bandwidth commitment to 500 Mbps and the burst bandwidth to 1000 Mbps.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyCrossRegionBandwidth
<Common Request Params>

Request:
{
  "crossRegionBandwidthId": "<your cross id>",
  "bandwidth": 500,
  "bandwidthCap": 1000
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

3. For a cross-region bandwidth with the network model of ByInstanceBandwidth95, modify the bandwidth commitment to 500 Mbps and leave the burst bandwidth unchanged.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyCrossRegionBandwidth
<Common Request Params>

Request:
{
  "crossRegionBandwidthId": "<your cross id>"
  "bandwidth": 500
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

4. For a cross-region bandwidth with the network model of ByInstanceBandwidth95, modify the burst bandwidth to 1000 Mbps and leave the bandwidth commitment unchanged.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyCrossRegionBandwidth
<Common Request Params>

Request:
{
  "crossRegionBandwidthId": "<your cross id>"
  "bandwidthCap": 1000
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code
Error Code
Description

404

INVALID_VPC_BANDWIDTH_NOT_FOUND

Cross-region bandwidth does not exist.

400

OPERATION_DENIED_VPC_BANDWIDTH_STATUS

Cross-region bandwidth state does not allow operation.

400

INVALID_PARAMETER_BANDWIDTH

Invalid bandwidth value.

Last updated