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 how to obtain the project ID, see Obtaining Required Information.
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

Request parameters
None

Example request

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

Response

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.

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

{
    "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.