Updated on 2024-12-02 GMT+08:00

Querying a Specific API Version

Function

Query a specific API version of SWR.

URI

GET /{api_version}

For details about parameters, see Table 1.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

api_version

Yes

String

API version

Request

  • Request parameters
    Table 2 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.

  • Example request
    GET https://{Endpoint}/v2

Response

  • Response parameters
    Table 3 Response body parameter description

    Parameter

    Type

    Description

    version

    Object

    A list of objects related to the version.

    Table 4 version 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 2018-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 5 links parameter description

    Parameter

    Type

    Description

    href

    String

    Link

    rel

    String

    Description

  • Example response
    {
        "version": {
            "id": "v2",
            "links": 
                {
                    "href": "https://xxx",
                    "rel": "self"
                }
            "min_version": "2.0",
            "status": "CURRENT",
            "updated": "2017-12-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.