Replace Server Metadata Items¶

Overview¶

This API creates or replaces metadata for a specified server. All existing metadata items are removed and completely replaced by the metadata items in the request. If you don’t want to remove existing items, please use Merge Server Metadata Items.

Classification¶

Replace

API Operation Object¶

Metadata

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

POST

HTTP Request Path¶

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

HTTP Request Header¶

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

HTTP Request Body¶

Format¶

{
  "metadata": "<metadata>",

  ...
}

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
metadata	Request	Metadata	Metadata of the server.	required	-	Terminate	400, 500

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
404	not found a specified item
405	request URL or method is invalid
500	compute fault

HTTP Response Body¶

Format¶

{
  "metadata": "<metadata>",

  ...
}

Response Parameter¶

Response Parameters¶
item	format		description
metadata	Metadata		Metadata of the server.

Sample Request and Response¶

Sample API Request¶

Request URI¶

https://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/servers/8b59526b-daf5-46db-9c44-e77c0a34bf2c/metadata

HTTP Request Header¶

POST /v2/b322a85578de48beba0f92acce57869b/servers/8b59526b-daf5-46db-9c44-e77c0a34bf2c/metadata 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¶

{
  "metadata": {
    "foo": "hoge"
  }
}

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¶

{
  "metadata": {
    "foo": "hoge"
  }
}

Merge Server Metadata Items

Show Server Metadata Item