Show Stock¶

Overview¶

This API shows Baremetal Server stock information.

Classification¶

GET

API Operation Object¶

Stock

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

GET

HTTP Request Path¶

{api_endpoint}/v2/{tenant_id}/stock?flavor_id={flavor_id}&availability_zone={availability_zone}

HTTP Request Header¶

Accept: application/json
Content-Type: application/json
X-Auth-Token: <token>

HTTP Request Body¶

Format¶

This API does not allow request body.

Request Parameter¶

Input Parameters¶
name	style	format	description	required/optional	default value	action for invalid parameter	response code for invalid parameter
flavor_id	query	UUID	UUID of the flavor for search stock.	required	-	Terminate	400
availability_zone	query	String	Name of the AvailabilityZone. If you specified this parameter, search stock from baremetal servers that matching AvailabilityZone and flavor_id. If you omit this parameter, stock search from all baremetal servers that matching flavor_id.	optional	-	Terminate	400

Response¶

HTTP Response Header¶

Format¶

HTTP/1.1 200 OK

<response_code>: see “HTTP Responses” section
<message>: message based on the response code

Response Code¶

Response Codes¶
response code	condition
200	normal end
400	specified parameter is invalid
401	unauthorized
403	tenant is not available
405	request URL or method is invalid
413	any parameter is over the maximum number
500	compute fault

HTTP Response Body¶

Format¶

{
    "stock": {
        "flavor_id": "c7151446-f822-453f-a490-89fc8ec4a423",
        "availability_zone: "zone1-groupa",
        "stock": true
    }
}

Response Parameter¶

Response Parameters¶
item	format		description
stock	Stock	Baremetal Server stock information.

Sample Request and Response¶

Sample API Request¶

Request URI¶

https://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/stock?flavors_id=8b59526b-daf5-46db-9c44-e77c0a34bf2c&availability_zone=groupa

HTTP Request Header¶

GET /v2/b322a85578de48beba0f92acce57869b/stock?flavors_id=8b59526b-daf5-46db-9c44-e77c0a34bf2c&availability_zone=groupa HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Accept: application/json
Content-Type: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588

HTTP Request Body¶

none

Sample API Response¶

HTTP Response Header¶

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-length>
Date: Thu, 17 Jul 2014 04:21:06 GMT

HTTP Response Body¶

{
    "stock": {
        "flavor_id": "c7151446-f822-453f-a490-89fc8ec4a423",
        "availability_zone": "zone1-groupa",
        "stock": true
    }
}

2.9. Stock

2.10. UEFI