DescribeInstanceInternetStatus

1. 接口描述

调用本接口用于查询实例带宽、流量包状态。

2. 请求参数

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

参数名称必选类型描述

instanceId

String

待操作的实例ID。

可通过DescribeInstances接口返回值中的instanceId获取。

3. 响应结果

参数名称类型描述

requestId

String

唯一请求 ID。

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

instanceId

String

虚拟机实例ID。

instanceName

String

实例的名称。

internetMaxBandwidthOut

Integer

当前实例的公网出口带宽大小。

modifiedInternetMaxBandwidthOut

Integer

实例将要修改公网出口带宽大小。 取值可能为空,说明未取到有效值。

modifiedBandwidthStatus

String

实例带宽状态。

Processing: 变更中

Enable: 可用

WaitToEnable: 下周期变更

trafficPackageSize

Float

当前实例流量包大小。 单位:TB。

modifiedTrafficPackageSize

Float

实例要修改流量包大小 单位:TB。

modifiedTrafficPackageStatus

String

实例流量包状态。

Processing: 变更中

Enable: 可用

WaitToEnable: 下周期变更

4. 代码示例

1. 查询实例固定带宽状态

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

Request:
{
  "instanceId": "instanceId"
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {  
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "instanceId": "xx",
    "instanceName": "xx",
    "internetMaxBandwidthOut": "100",
    "modifiedInternetMaxBandwidthOut": null,
    "modifiedBandwidthStatus": "Enable",
    "trafficPackageSize": null,
    "modifiedTrafficPackageSize": null,
    "modifiedTrafficPackageStatus": null
   }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码错误码说明

最后更新于