On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

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

Querying an API Version

Updated on 2025-04-01 GMT+08:00

Online Debugging

CLI Examples

View PDF

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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	EPS 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.

Response Parameters

Status code: 200

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

**Table 4** 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 minor versions, the latest minor version is returned. If minor versions are not supported, an empty string 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 minor versions, the earliest minor version is returned. If minor versions are not supported, an empty string is returned.

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

Status code: 400

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

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

Status code: 401

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

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

Status code: 403

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

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

Status code: 404

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

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

Status code: 405

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

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

Status code: 406

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

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

Status code: 408

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

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

Status code: 409

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

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

Status code: 410

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

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

Status code: 412

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

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

Status code: 429

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

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

Status code: 500

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

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

Status code: 501

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

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

Status code: 503

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

**Table 33** 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