Function

This API is used to query versions of VPCEP APIs.

v2 cannot be used.

URI

GET /

Request

Example request
GET https://{endpoint}/

Response

Parameters

**Table 1** Response parameters
Parameter	Type	Description
versions	Array of objects	Lists the versions of VPCEP APIs. For details, see Table 2.

**Table 2** **VersionModel** parameters
Parameter	Type	Description
status	String	Specifies the version status. CURRENT: indicates a major version. SUPPORT: indicates an earlier version which is still supported. DEPRECATED: indicates a deprecated version that may be deleted later.
id	String	Specifies the version ID.
updated	String	Specifies the time when the API version was released. The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.
version	String	Specifies the supported version.
min_version	String	Specifies the microversion number. If the APIs do not support microversions, the value is left blank.
links	Array of objects	Specifies the API URL. For details, see Table 3.

**Table 3** **VersionLink** parameters
Parameter	Type	Description
href	String	Specifies the reference address of the current API version.
type	String	Specifies the MIME type of the entity sending the request. The value is application/json.
rel	String	Specifies the relationship between the current API version and the referenced address.

Example response

{
    "versions": [
        {
            "status": "CURRENT",
            "id": "v1",
            "updated": "2018-09-30T00:00:00Z",
            "version": "1",
            "links": [
                {
                    "rel": "self",
                    "href": "https://{vpcep_uri}/v1",
                    "type": "application/json"
                }
            ],
            "min_version": ""
        },
        {
            "status": "CURRENT",
            "id": "v2",
            "updated": "2020-03-30T00:00:00Z",
            "version": "2",
            "links": [
                {
                    "rel": "self",
                    "href": "https://{vpcep_uri}/v2",
                    "type": "application/json"
                }
            ],
            "min_version": ""
        }
    ]
}

Status Codes

See Status Codes.

Querying Versions of VPCEP APIs

Function

URI

Request

Response

Status Codes