Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>

2024-06-20 15:01:38 +00:00

11 KiB

Raw Permalink Blame History

Listing All SMN API Versions

Description

API name
QueryApiSupportVersions
Function
List all SMN API versions.

URI

URI format
GET /

Request

Example request
```
GET https://{SMN_Endpoint}/
```

Response

Parameter description

Parameter	Type	Description
versions	Versions structure	Version object list. For details, see Table 1.

**Table 1** Versions structure
Parameter	Type	Description
id	String	Version number, for example, v2
min_version	String	Minimum micro-version number. If the APIs do not support micro-versions, no information will be returned.
status	String	Version status, which can be the following: CURRENT: widely used version SUPPORTED: earlier version that is still supported DEPRECATED: deprecated version that may be deleted later
updated	String	Version release time, which must be UTC time. For example, the release time of v2 is 2014-06-28T12:20:21Z.
version	String	Maximum micro-version number. If the APIs do not support micro-versions, no information will be returned.
links	Links structure array	URL of an API. For details, see Table 2.

**Table 2** Links structure
Parameter	Type	Description
href	String	Shortcut link
rel	String	Shortcut link marker name

Example response

{
    "versions": [
        {
            "id": "v2",
            "links": [
                {
                    "href": "https://127.0.0.1/v2",
                    "rel": "self"
                }
            ],
            "min_version": "",
            "status": "CURRENT",
            "updated": "2018-09-19T00:00:00Z",
            "version": ""
        }
   ]
}

Returned Value

See Returned Value.

Error Codes

See Error Codes.

Parent topic: Version Querying

11 KiB Raw Permalink Blame History

Listing All SMN API Versions

Description

URI

Request

Response

Returned Value

Error Codes

11 KiB

Raw Permalink Blame History