Help Center/ Bare Metal Server/ API Reference (Paris Region)/ Native OpenStack Nova V2.1 APIs/ BMS Metadata Management/ Querying BMS Metadata (Native OpenStack API)
Updated on 2022-02-22 GMT+08:00
View PDF
Share

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

Request Message

  • Request parameters

    None

  • Example request 
    1
    		 
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata

Response Message

  • Response parameters

    Parameter

    Type

    Description

    metadata

    Object

    Specifies the user-defined metadata key and value pair. For details, see Table 2.
    Table 2 metadata field data structure description

    Parameter

    Type

    Description

    User-defined field key and value pair

    String

    Specifies the key and value pair of the metadata.

    The maximum size for each metadata key and value pair is 255 bytes.
  • Example response 
    1
2
3
4
5
    		 
    {
    "metadata": {
        "key": "value"
    }
}

Returned Values

Normal values

Returned Values

Description

200

The server has successfully processed the request.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.

Parent topic: BMS Metadata Management