ModifyInstanceBandwidth

1. API Description

The API is used to modify the public bandwidth of a virtual machine instance.

Note

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

• 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.

• If the internetChargeType of your instance is not ByBandwidth, the bandwidth change takes immediate effect.

• This API is an async API. 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(s). To obtain the instance IDs, you can call DescribeInstances and look for instanceId in the response.
internetMaxBandwidthOut	Yes	Integer	Egress bandwidth size. Valid value: ≥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 instance bandwidth.

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

Request：
{
  "instanceId": "instanceId",
  "internetMaxBandwidthOut": 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
404	INVALID_INSTANCE_NOT_FOUND	Instance does not exist.
403	OPERATION_DENIED_INSTANCE_NOT_RUNNING	Only operations on instances in RUNNING status are supported.
400	INVALID_PARAMETER_BANDWIDTH_EXCEED	Bandwidth size exceeds the maximum limit.
403	OPERATION_DENIED_INSTANCE_EXIST_PLAN_BANDWIDTH	A scheduled change exists. Please cancel first to continue.
403	OPERATION_DENIED_INSTANCE_BANDWIDTH_PROCESSING	Bandwidth size is changing.