Updating the Metadata Configuration of a BMS

Function

This API is used to update the metadata configuration of a BMS.

Constraints

This function is only available in the LA-Sao Paulo1 region.
The BMS must be in active, stopped, paused, or suspended state. The state is indicated by the OS-EXT-STS:vm_state parameter.

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:updateMetadataOptions	write	instance*	g:EnterpriseProjectId g:ResourceTag/<tag-key> bms:MetadataOptionsHttpEndpoint bms:MetadataOptionsHttpTokens	-	-

URI

PUT /v1/{project_id}/baremetalservers/{server_id}/metadata-options

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
server_id	Yes	Specifies the BMS ID. You can obtain the BMS ID from the BMS console or by calling the API Querying BMSs (Deprecated).

Request Parameters

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
http_endpoint	No	String	Specifies whether the IMDS service is enabled. The default value is enabled. enabled: IMDS is enabled. disabled: IMDS is disabled.
http_tokens	No	String	Specifies whether the token is optional. The default value is optional. optional: The token is optional. required: The token is required, which means IMDS v1 is disabled and IMDS v2 is enabled.

Example Request

Updating the metadata configuration of a BMS (ID: cf2a8b97-b5c6-47ef-9714-eb27adf26e5b)

PUT https://{BMS Endpoint}/v1/{project_id}/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata-options

{
"http_endpoint": "enabled",
"http_tokens": "required"
}