ModifyInstanceTrafficPackage

1. 接口描述

调用本接口用于修改虚拟机实例流量包大小。

准备工作

注意事项

  • 当机器状态处于RUNNING or STOPPED状态,接口能被调用。

  • 若机器的internetChargeTypeByTrafficPackage

    • 机器的instanceChargeTypePREPAID

      • 升配(target > cur)会生成待支付的订单,需要扣除本次升配的费用,立即生效。

      • 降配(target < cur)会生成下个周期的降配订单,下周期生效。

  • 本接口调用是异步操作,你可以调用DescribeInstanceInternetStatus来查看变更的结果。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

instanceId

String

待操作的实例ID。

trafficPackageSize

Float

流量包大小。 单位:TB

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

orderNumber

String

订单编号。

4. 代码示例

1. 升配实例流量包

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. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码
错误码
说明

403

OPERATION_DENIED_INTERNET_CHARGE_TYPE_NOT_SUPPORT

403

OPERATION_FAILED_INSTANCE_EXIST_PLAN_TRAFFIC_PACKAGE

指定的实例存在降配计划订单。

400

INVALID_PARAMETER_TRAFFIC_PACKAGE_LESS

实例流量包参数需要大于等于默认值。

400

INVALID_PARAMETER_TRAFFIC_PACKAGE_EXCEED

流量包参数超过最大值。

400

INVALID_INSTANCE_NOT_FOUND

指定的实例不存在。

400

INVALID_PARAMETER_TRAFFIC_PACKAGE

流量包参数不符合。

403

OPERATION_DENIED_INSTANCE_STATUS_NOT_SUPPORT

指定的实例状态不支持。

403

OPERATION_FAILED_INSTANCE_NOT_EXIST_TRAFFIC_PACKAGE

指定的实例不存在流量包。

最后更新于