Show UEFI

Overview

This API shows the UEFI setting information for specified Baremetal server.

Classification

  • Get

API Operation Object

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v2/{tenant_id}/servers/{server_id}/uefi

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
tenant_id URL UUID ID for the tenant. required - Terminate 403, 404
server_id URL UUID ID for the server. required - Terminate 404
token Header Authentication token string Keystone authentication token. required - Terminate 401

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
401 unauthorized
404 not found a specified item
405 request URL or method is invalid
415 bad media type
500 compute fault. If an error other than above has occurred, the response code is always 500.

HTTP Response Body

Format

{
  "uefi": "<uefi>"
}

Response Parameter

Response Parameters
item format   description
uefi UEFI   UEFI setting of specified Baremetal server

Sample Request and Response

Sample API Request

Request URI

https://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/servers/8c063778-a196-4671-87ed-06aabea3d480/uefi

Request Header

GET /v2/b322a85578de48beba0f92acce57869b/servers/8c063778-a196-4671-87ed-06aabea3d480/uefi 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

Request Body

  • none

Sample API Response

Response Header

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

Response Body

{
  "uefi": {
    "flavor_name": "General Purpose 2",
    "flavor_id": "fcec5541-81c3-4963-ba6f-dc24773ebf7f",
    "updated": "2012-09-07T16:56:37Z",
    "status": "SUCCESS",
    "message": "",
    "setting": {
      "hoge": {
        "value": "Enabled",
        "default": "Enabled",
        "type": "enum",
        "selection": ["Enabled", "Disabled"]
      },
      "fuga": {
        "value": "Disabled",
        "default": "Enabled",
        "type": "enum",
        "selection": ["Enabled", "Disabled"]
      }
    }
  }
}