Help Center/ Tag Management Service/ API Reference/ API Description/ API Version Querying/ Querying Details About an API Version

Updated on 2024-01-09 GMT+08:00

View PDF

Querying Details About an API Version

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /{api_version}

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

Request Parameters

**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 Identity and Access Management (IAM) API to obtain a user token, set the scope field to domain. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
version	VersionDetail object	Specifies the version details.

**Table 4** VersionDetail
Parameter	Type	Description
id	String	Specifies the version ID, for example, v1.0.
links	Array of Link objects	Specifies the API URL.
version	String	If the APIs of this version support microversions, the supported latest microversion is returned. If the microversion is not supported, no information is returned.
status	String	Specifies the version status. Possible values are as follows: CURRENT: widely used version SUPPORTED: earlier version which is still supported DEPRECATED: deprecated version which may be deleted later
updated	String	Specifies the version release time, which is a UTC time. For example, the release time of v1.0 is 2016-12-09T00:00:00Z.
min_version	String	If the APIs of this version support microversions, the supported earliest microversion is returned. If the microversion is not supported, no information is returned.

**Table 5** Link
Parameter	Type	Description
href	String	Specifies the API URL.
rel	String	self

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 7** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 9** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 11** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 406

**Table 12** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 13** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 408

**Table 14** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 15** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 409

**Table 16** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 17** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 410

**Table 18** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 19** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 412

**Table 20** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 21** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 429

**Table 22** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 23** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 500

**Table 24** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 25** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 501

**Table 26** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 27** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 503

**Table 28** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 29** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Example Requests

Querying details about a TMS API version

GET https://{Endpoint}/v1.0

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	OK
400	Bad Request
404	Not Found
405	Method Not Allowed
406	Not Acceptable
408	Request Timeout
409	Conflict
410	Gone
412	Precondition Failed
429	Too Many Requests
500	Internal Server Error
501	Not Implemented
503	Service Unavailable