Help Center> Bare Metal Server> API Reference> Native OpenStack Nova V2.1 APIs> BMS Metadata Management> Querying BMS Metadata (Native OpenStack API)
Updated on 2024-01-31 GMT+08:00
View PDF

Querying BMS Metadata (Native OpenStack API)

Function

The BMS metadata includes BMS basic information on the cloud platform, such as the BMS ID, hostname, and network information. This API is used to query the BMS metadata.

Constraints

Pagination query is not supported.

URI

GET /v2.1/{project_id}/servers/{server_id}/metadata

Table 1 lists the parameters.

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 Querying BMSs (Native OpenStack API).

Request Parameters

None

Example Request

Querying metadata of a BMS (ID: 95bf2490-5428-432c-ad9b-5e3406f869dd) 
1
 
GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata

Response Parameters

Parameter

Type

Description

metadata

Map<String,String>

Specifies a user-defined metadata key-value pair. Each key or value contains a maximum of 255 characters.

Example Response

1
2
3
4
5
 
{
    "metadata": {
        "key": "value"
    }
}

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.

Parent topic: BMS Metadata Management