Updating BMS Metadata

Function

This API is used to update BMS metadata.

• If the metadata does not contain the target field, the field is automatically added to the field.
• If the metadata contains the target field, the field value is automatically updated.
• If the field in the metadata is not requested, the field value remains unchanged.

Constraints

The BMS must be in active, stopped, or paused state. The state is indicated by the OS-EXT-STS:vm_state parameter.

Debugging

You can debug this API in API Explorer.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

• If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
• If you are using identity policy-based authorization, the permission listed below is required.

  Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
  bms:servers:updateMetadata	write	instance*	g:EnterpriseProjectId g:ResourceTag/<tag-key> bms:MetadataAgencyName	-	iam:agencies:pass

URI

POST /v1/{project_id}/baremetalservers/{server_id}/metadata

Request Parameters

Example Request

1

POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata

1
2
3
4
5

{
    "metadata": {
        "key": "value"
    }
}

Response Parameters

Example Response

1
2
3
4
5

{
    "metadata":{
        "key": "value"
    }
} 

Returned Values

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.