InquiryPriceInstanceBandwidth

1. API Description

This API is used to query the price of modified instance bandwidth.

Note

  • Use this API only when InternetChargeType is ByBandwidth. When the target bandwidth > default bandwidth, a price returns.

  • Price structure varies by instanceChargeType.

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.

bandwidthOutMbps

Yes

Integer

Bandwidth size.

3. Output Parameters

Parameter Name
Type
Description

bandwidthPrice

Array of Price

Price of public bandwidth. Kinds of prices may exist. For example, traffic package billing method may contain the package price and overage price.

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Query the price of modified instance bandwidth

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

Request:
{
  "instanceId": "instanceId",
  "bandwidthOutMbps": 100
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {  
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "bandwidthPrice": [
        {
            "discount": 100.0,
            "discountPrice": null,
            "originalPrice": null,
            "unitPrice": 1.32,
            "discountUnitPrice": 1.32,
            "chargeUnit": "HOUR",
            "stepPrices": 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.

403

OPERATION_DENIED_INTERNET_CHARGE_TYPE_NOT_SUPPORT

InternetChargeType is not ByBandwidth.

400

INVALID_INSTANCE_TYPE_ZONE_NO_SELL

Bandwidth of the specified instance is not currently available for sale.

Last updated