Querying the SMN API v2 Version

Description

  • API name

    QueryV2ApiInfo

  • Function

    Query the SMN API v2 version information.

URI

  • URI format

    GET /{api_version}

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    api_version

    Yes

    String

    Version to be queried

    Note

    Currently, only v2 is supported.

Request

  • Example request

    GET https://{SMN_Endpoint}/v2
    

Response

  • Parameter description

    Table 1 Parameter in the response

    Parameter

    Type

    Description

    version

    Object

    Version information

    Table 2 Description of the version field

    Parameter

    Type

    Description

    id

    String

    Version number, for example, v2

    links

    Links structure array

    URL of an API. For details, see Table 3.

    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.

    Table 3 Links structure

    Parameter

    Type

    Description

    href

    String

    Shortcut link

    rel

    String

    Shortcut link marker name

  • Example response

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