ServerInventory

1. API Description

This API is used to describe the status of available resources.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

instanceChargeType

Yes

String

Instance pricing model.

PREPAID: subscription

POSTPAID: pay-as-you-go

zoneId

No

String

Zone ID.

instanceTypeId

No

String

Instance model ID.

sellStatus

No

String

Status of sale.

  • SELL: available for sale, stock > 10.

  • SELL_SHORTAGE: available for sale, stock < 10.

  • SOLD_OUT: sold out.

3. Output Parameters

Parameter Name
Type
Description

availableResources

Array of AvailableResource

Status of available resources.

requestId

String

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

4. Code Example

Query available resources

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

Request:
{
  "instanceTypeId": "MDE",
  "instanceChargeType": "PREPAID",
  "zoneId": "MOW-B"
}

Response:
{
  "requestId": "T001A67B7-C345-4B0E-A9B0-FB0C859C9075",
  "response": {
    "requestId": "T001A67B7-C345-4B0E-A9B0-FB0C859C9075",
    "availableResources": [
      {
        "zoneId": "MOW-B",
        "status": "SELL",
        "internetChargeTypes": [
          "ByBandwidth",
          "ByTrafficPackage"
        ],
        "instanceTypeId": "MDE",
        "maximumBandwidthOut": 10000,
        "defaultBandwidthOut": 50,
        "defaultTrafficPackageSize": 5.0
      }
    ]
  }
}

5. 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_ZONE_NOT_FOUND

Zone not found.

400

INVALID_CHARGE_TYPE_NOT_SUPPORT

Pricing model not supported. If necessary, please contact Harmony Networks Support.

Last updated