doc-exports/docs/bms/api-ref/en-us_topic_0060402469.html
Hasko, Vladimir daef1357e6 manually adding BMS content due to bug in gitea
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2022-10-25 09:38:20 +00:00

11 KiB

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 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
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata
    

Response

  • 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.

    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.