2.6.2. Create or replace server metadata

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

Creates or replaces metadata for a specified server.

Replaces items that match the specified keys. If you omit a key that already exists, the key retains its value.

If the number of metadata items exceeds the quota for metadata items, an overLimit (413) fault might be thrown.

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.2.1. Request

This table shows the URI parameters for the create or replace server metadata 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.

 

Example 2.51. Create or replace server metadata: JSON request

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

 

Example 2.52. Create or replace server metadata: 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.2.2. Response

 

Example 2.53. Create or replace server metadata: JSON response

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

 

Example 2.54. Create or replace server metadata: 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...