Querying Details About a Specified TMS API Version¶

Function¶

This API is used to query the details of a specified TMS API version.

URI¶

GET /{api_version}

Request¶

Parameter description

**Table 1** Parameters in the request¶
Parameter	Mandatory	Type	Description
api_version	Yes	String	Specifies the API version.

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. TMS is a global service. When calling the IAM API to obtain a user token, set scope to domain. The value of X-Subject-Token in the response header is the user token.

Example request
```
GET https://{TMS endpoint}/v1.0
```

Response¶

Parameter description
Table 3 Parameters in the response¶
Name
Type
Description
version
object
Specifies the version of a specified API.
For details, see Table 4.

**Table 3** Parameters in the response¶
Name	Type	Description
version	object	Specifies the version of a specified API. For details, see Table 4.

version field description

**Table 4** 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 5.
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 values 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 5 Parameter description¶
Name
Type
Description
href
String
Specifies the API URL.
rel
String
self

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

Example response

Status code: 200

Successful operation

{
    "version": {
        "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