Help Center> Enterprise Management> API Reference> Enterprise Project Management APIs> API Version Querying> Querying an API Version

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

View PDF

Querying an API Version

Function

This API is used to querying details about an 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	Version ID, for example, v1.0.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
version	VersionDetail object	Version details.

**Table 3** VersionDetail
Parameter	Type	Description
id	String	Version ID, for example, v1.0.
links	Array of Link objects	API URL.
version	String	If the APIs of this version support microversions, the supported minimum microversion is returned. If microversions are not supported, no information is returned.
status	String	Version status. Possible values are as follows: CURRENT: primary version. SUPPORTED: earlier version which is still supported. DEPRECATED: deprecated version which may be deleted later.
updated	String	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 minimum microversion is returned. If microversions are not supported, no information is returned.

**Table 4** Link
Parameter	Type	Description
href	String	API URL.
rel	String	Self.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 6** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 8** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 10** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 12** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 405

**Table 13** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 14** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 406

**Table 15** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 16** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 408

**Table 17** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 18** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 409

**Table 19** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 20** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 410

**Table 21** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 22** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 412

**Table 23** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 24** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 429

**Table 25** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 26** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 27** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 28** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 501

**Table 29** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 30** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 503

**Table 31** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 32** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

None

Example Responses

Status code: 200

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

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
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