Updated on 2024-04-19 GMT+08:00

Querying All API Versions

Function

Query all available API versions of SWR.

URI

GET /

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). The value can be application/json or charset=utf-8 application/json.

The default value is application/json.

X-Auth-Token

Yes

String

User token.

The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response

  • Response parameters
    Status code: 200
    Table 2 Response body parameter description

    Parameter

    Type

    Description

    versions

    Array of objects

    A list of objects related to the version.

    Table 3 versions parameter description

    Parameter

    Type

    Description

    id

    String

    Version ID (version number), for example, v2.

    links

    Object

    API URL.

    version

    String

    If the APIs of this version support microversions, set this parameter to the supported maximum microversion. If the microversion is not supported, leave this parameter blank.

    status

    String

    Version status. The options are as follows:

    • CURRENT: The version is the primary version.
    • SUPPORTED: The version is an old version, but it is still supported.
    • DEPRECATED: The version is a deprecated version, which may be deleted later.

    updated

    String

    Version release time, which must be the UTC time. For example, the release time of v2 is 2014-06-28T12:20:21Z.

    min_version

    String

    If APIs of this version support microversions, set this parameter to the supported minimum microversion. If the microversion is not supported, leave this parameter blank.

    Table 4 links parameter description

    Parameter

    Type

    Description

    href

    String

    Link

    rel

    String

    Description

  • Example response
    { 
       "versions": [
            {
                "id": "v2",
                "links": 
                    {
                        "href": "https://xxx",
                        "rel": "self"
                    }
                "min_version": "2.0",
                "status": "CURRENT",
                "updated": "2020-07-09T00:00:00Z",
                "version": "2.26",
            }
        ]
    }

Status Code

Status Code

Description

200

Request successful.

500

Failed to complete the request because of an internal service error.

Error Codes

For details, see Error Codes.