ModifyInstanceTrafficPackage

1. API Description

The API is used to modify the traffic package of an instance.

Note

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

• If the internetChargeType of your instance is ByTrafficPackage

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

• Use InquiryPriceInstanceTrafficPackage to query price of traffic package.

• 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.
trafficPackageSize	Yes	Float	Traffic package size. The value must be a multiple of 0.05.

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 traffic package of an instance

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

Request：
{
  "instanceId": "instanceId",
  "trafficPackageSize: 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_DENIED_INSTANCE_TRAFFIC_PACKAGE_PROCESSING	Traffic package is being modified.
403	OPERATION_DENIED_INTERNET_CHARGE_TYPE_NOT_SUPPORT	InternetChargeType is not ByTrafficPackage.
400	INVALID_PARAMETER_TRAFFIC_PACKAGE_ERROR	Traffic package parameter validation error. Invalid value, which must be a multiple of 0.05.
403	OPERATION_FILED_INSTANCE_NOT_EXIST_TRAFFIC_PACKAGE	No traffic package exists.
403	OPERATION_FAILED_INSTANCE_EXIST_PLAN_TRAFFIC_PACKAGE	Scheduled downgrade order exists.
400	INVALID_PARAMETER_TRAFFIC_PACKAGE_LESS	Traffic package parameter needs to be greater than or equal to the default value.
400	INVALID_PARAMETER_TRAFFIC_PACKAGE_EXCEED	Traffic package parameter exceeds upper limit.
404	INVALID_INSTANCE_NOT_FOUND	Instance does not exist.
403	OPERATION_DENIED_INSTANCE_STATUS_NOT_SUPPORT	Instance state not supported. Please power off your instance.