Updated on 2025-08-15 GMT+08:00

Querying the Metadata Configuration of a BMS

Function

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

Constraints

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

URI

GET /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

None

Example Request

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

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

Response 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 Response

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

Returned Values

Normal values

Returned Values

Description

200

The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.