DescribeInstanceInternetStatus

1. API Description

This API is used to query the bandwidth and traffic package 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.

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.
instanceId	String	Instance ID.
instanceName	String	Instance name.
internetMaxBandwidthOut	Integer	Current instance bandwidth.
modifiedInternetMaxBandwidthOut	Integer	Modified instance bandwidth.
modifiedBandwidthStatus	String	Status of instance bandwidth. Processing: modifying. Enable: effective now. WaitToEnable: effective in next billing cycle.
trafficPackageSize	Float	Current instance traffic package
modifiedTrafficPackageSize	Float	Modified instance traffic package
modifiedTrafficPackageStatus	String	Status of instance traffic package Processing: modifying. Enable: effective now. WaitToEnable: effective in next billing cycle.

4. Code Example

Example

Query status of instance flat rate bandwidth

POST /api/v2/bmc 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. 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.