Querying the API Versions¶

Function¶

This API is used to query the versions of all TMS APIs.

URI¶

GET /

Request¶

Example request

GET https://{TMS endpoint}/

Note

You can obtain the TMS endpoints from Regions and Endpoints.

Response¶

Parameter description
Table 1 Parameters in the response¶
Name
Type
Description
versions
Array
Specifies all API versions.
For details, see Table 2.

**Table 1** Parameters in the response¶
Name	Type	Description
versions	Array	Specifies all API versions. For details, see Table 2.

versions field description

**Table 2** Parameter description¶
Name	Type	Description
id	String	Specifies the version ID, for example, v1.0.
links	List<Link>	Specifies the API URL. For details, see Table 3.
version	String	If the APIs of this version support microversions, set this parameter to the supported latest microversion. If not, leave this parameter blank.
status	String	Specifies the version status. Possible statuses are as follows: CURRENT: indicates that the version is the primary version. SUPPORTED: indicates that the version is an old version, but it is still supported. DEPRECATED: indicates a deprecated version which may be deleted later.
updated	String	Specifies the version release time, which must be the UTC time. For example, the release time of TMS 1.0 is 2016-12-09T00:00:00Z.
min_version	String	If the APIs of this version support microversions, set this parameter to the supported earliest microversion. If not, leave this parameter blank.

Links field description
Table 3 Parameter description¶
Name
Type
Description
href
String
Specifies the API URL.
rel
String
self

**Table 3** Parameter description¶
Name	Type	Description
href	String	Specifies the API URL.
rel	String	self

Example response

Status code: 200

Successful operation

{
    "versions": [
        {
            "id": "v1.0",
            "links": [
                {
                    "rel": "self",
                    "href": "https://API URL/v1.0"
                }
            ],
            "version": "",
            "status": "CURRENT",
            "updated": "2016-12-09T00:00:00Z",
            "min_version": ""
        }
    ]
}

Status Codes¶

See Status Codes.

Error Codes¶

See Error Codes.

last updated: 2024-09-09 10:26 UTC - commit: 414d52de313599f3458a21d3fd713968d5d119f9