ModifyInstanceTrafficPackage

1. API Description

The API is used to modify the data transfer package of a virtual machine instance.

Prerequisites

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.

  • This API is an async API. Use DescribeInstanceInternetStatus to query data transfer 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.

trafficPackageSize

Yes

Float

Size of data transfer package. Unit: TB.

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

Upgrade instance data transfer package.

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

Request:
{
  "instanceId": "instanceIdxxx",
  "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_INTERNET_CHARGE_TYPE_NOT_SUPPORT

Only operations on instance whose internetChargeType is ByTrafficPackage are supported.

403

OPERATION_FAILED_INSTANCE_EXIST_PLAN_TRAFFIC_PACKAGE

A scheduled change exists. Please cancel first to continue.

400

INVALID_PARAMETER_TRAFFIC_PACKAGE_LESS

Data transfer size cannot be smaller than the default value.

400

INVALID_PARAMETER_TRAFFIC_PACKAGE_EXCEED

Data transfer size exceeds the maximum limit.

400

INVALID_INSTANCE_NOT_FOUND

Instance does not exist.

400

INVALID_PARAMETER_TRAFFIC_PACKAGE

Invalid data transfer size.

403

OPERATION_DENIED_INSTANCE_STATUS_NOT_SUPPORT

Only operations on instances whose status is RUNNING or STOPPED are supported.

403

OPERATION_FAILED_INSTANCE_NOT_EXIST_TRAFFIC_PACKAGE

Instance is not billed by data transfer.

Last updated