ModifyInstanceBandwidth

1. API Description

This API (ModifyInstanceBandwidth) is used to The API is used to modify the bandwidth of an instance.

Note

• Bandwidth cap differs with different instance models. You can call DescribeInstanceTypes to obtain.

• You can only perform this operation on instances whose status is RUNNING.

• If your current and target bandwidth are both in the free bandwidth scope, the change takes immediate effect.

• If the internetChargeType of your instance is ByBandwidth

  • For a PREPAID instance:

    • Upgrade (target > current) operation will deduct the amount required for this instance purchase. If the balance is insufficient, the request will fail and take effect immediately.

    • Downgrade (target < current) operation will generate an order for the next billing cycle and will take effect by then.

  • For a POSTPAID instance, the change takes immediate effect.

• Use InquiryPriceInstanceBandwidth to query price of bandwidth.

• Use DescribeInstanceInternetStatus to query bandwidth status of an instance.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
instanceId	Yes	String	Instance ID. To obtain the instance ID, you can call DescribeInstances and look for instanceId in the response.
bandwidthOutMbps	Yes	Integer	Bandwidth. Value range: from 1 to maximum supported for the instance model. Value 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.
orderNumber	String	Number of order.

4. Code Example

Example

Upgrade the bandwidth of an instance

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

Request：
{
  "instanceId": "instanceId",
  "bandwidthOutMbps": 100
}

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

5. Developer Resources

Zenlayer Cloud API 2.0 integrates 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
403	OPERATION_FAILED_INSTANCE_BANDWIDTH_PROCESSING	The specified instance bandwidth is being modified.
404	INVALID_INSTANCE_NOT_FOUND	Instance does not exist.
403	OPERATION_DENIED_HA_MODEL_TYPE_NOT_SUPPORT_BANDWIDTH	High availability instance types do not support bandwidth configuration.
403	OPERATION_DENIED_INSTANCE_NOT_RUNNING	Only operations on instances in RUNNING status are supported.
400	INVALID_PARAMETER_BANDWIDTH_EXCEED	Bandwidth parameter exceeds the maximum value.