Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>

2023-10-11 08:28:11 +00:00

17 KiB

Raw Permalink Blame History

Querying an API Version

Function

This API is used to query a specified API version of the BMS service.

URI

GET /{api_version}

Table 1 lists the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Description
api_version	Yes	Specifies the API version, for example, v1.

Request

Request parameters
None
Example request
1
GET https://{BMS Endpoint}/v1

Response

Response parameters

Parameter	Type	Description
version	Object	Specifies a specified API version of the BMS service. For details, see Table 2.

**Table 2** **version** field data structure description
Parameter	Type	Description
id	String	Specifies the API version ID.
links	Array of objects	Specifies the API URL. For details, see Table 3.
min_version	String	Specifies the earliest micro API version that is supported.
status	String	Specifies the API version status. CURRENT: indicates a primary version. SUPPORTED: indicates an earlier version that is still supported. DEPRECATED: indicates a deprecated version that may be deleted later.
updated	String	Specifies the release date of an API version. The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2018-09-30T00:00:00Z.
version	String	Specifies the latest micro API version that is supported.

**Table 3** **links** field data structure description
Parameter	Type	Description
href	String	Specifies the API URL.
rel	String	Specifies the API URL dependency. The value can be: self: resource link that contains the version number. It is used when immediate tracing is required. bookmark: resource link that can be stored for a long time.

Example response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "version": {
        "id": "v1",
        "links": [
            {
                "href": "http://bms.xxx.com/v1/",
                "rel": "self"
            }
        ],
        "min_version": "",
        "status": "CURRENT",
        "updated": "2018-09-30T00:00:00Z",
        "version": ""
    }
}

Returned Values

Normal values

Return Value	Description
200	The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.

Parent topic: API Version Query

17 KiB Raw Permalink Blame History