Querying the API Version List

Function

This API is used to query the currently supported API version list.

URI

• URI format

  GET https://{Endpoint}/

• Parameter description

  N/A

Requests

None

Responses

• Parameter description

  Table 1 Parameter description

  Name	Type	Description
  versions	Array of objects	Indicates the list of detailed API version information. For more information, see Table 2.

  Table 2 versions field data structure description

  Name	Type	Description
  id	String	Indicates the API version.
  links	Array of objects	Indicates the API link information. For more information, see Table 3. NOTE: If the version is v3, the value is [].
  status	String	Indicates the version status. The value CURRENT indicates that the version has been released.
  version	String	Indicates the subversion of the API version.
  min_version	String	Indicates the minimum API version.
  updated	String	Indicates the version update time. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the UTC.

  Table 3 links field data structure description

  Name	Type	Description
  href	String	Indicates the API URL and the value is "".
  rel	String	Its value is self, indicating that URL is a local link.

• Response example

  {
      "versions": [
          {
              "id": "v3",
              "links": [],
              "status": "CURRENT",
              "version": "",
              "min_version": "",
              "updated": "2017-02-07T17:34:02Z"
          }
      ]
  }

Status Code

Status Code:200.

For more information, see Status Code.

Error Code

For more information, see Error Code.