2.6.5. Create or update server metadata item

 
MethodURIDescription
PUT/v2/{tenant_id}/servers/{server_id}/metadata/{key}

Sets a metadata item by key for a specified server.

An overLimit (413) fault might be thrown if the operation causes the quota for metadata items to be exceeded.

Normal response codes: 200

Error response codes: computeFault (400, 500, ), serviceUnavailable (503), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413), itemNotFound (404), badMediaType (415), buildInProgress (409)

 2.6.5.1. Request

This table shows the URI parameters for the create or update server metadata item request:

NameTypeDescription

{tenant_id}

​U​U​ID

The tenant ID in a multi-tenancy cloud.

{server_id}

​U​U​ID

The UUID for the server.

{key}

​Metadata​Key

A string. Maximum length is 255 characters.

 

Example 2.61. Create or update server metadata item: JSON request

{
   "metadata":{
      "name":"test_server"
   }
}

 

Example 2.62. Create or update server metadata item: XML request

<?xml version='1.0' encoding='UTF-8'?>
<metadata xmlns="http://docs.openstack.org/compute/api/v1.1">
    <meta key="type">staging_server</meta>
</metadata>

 2.6.5.2. Response

 

Example 2.63. Create or update server metadata item: JSON response

{
   "metadata":{
      "name":"test_server",
      "server_type":"test"
   }
}

 

Example 2.64. Create or update server metadata item: XML response

<?xml version='1.0' encoding='UTF-8'?>
<metadata xmlns="http://docs.openstack.org/compute/api/v1.1">
    <meta key="type">staging_server</meta>
</metadata>

Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page


loading table of contents...