Help Center/ VPC Endpoint/ API Reference/ API/ Version Management/ Querying the Version of a Specified VPCEP API

Updated on 2022-12-13 GMT+08:00

View PDF

Querying the Version of a Specified VPCEP API

Function

Function This API is used to query the version of a specified VPCEP API.

URI

GET /{version}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
version	Yes	String	Specifies the version number to be queried. The value starts with v, for example, v1. If this parameter is left blank, versions of all VPCEP APIs are queried.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Specifies the MIME type of the request body. Default value application/json is recommended. For APIs used to upload objects or images, the MIME type varies depending on the flow type.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
version	VersionObject object	Specifies the VPCEP API versions.

**Table 4** VersionObject
Parameter	Type	Description
status	String	Specifies the version status.● CURRENT: indicates a primary version.● SUPPORT: indicates an earlier version which is still supported. ● DEPRECATED: indicates deprecated version which may be deleted later.
id	String	Specifies the API version ID.
updated	String	Specifies the time the API version was released. The applied UTC time format is YYYY-MMDDTHH:MM:SSZ.
version	String	Specifies the supported version number.
min_version	String	Specifies the supported microversion number. If the APIs do not support microversions, the parameter is left blank.
links	Array of Link objects	Specifies the API URL.

**Table 5** Link
Parameter	Type	Description
href	String	Specifies the reference address of the current API version.
type	String	Specifies the MIME type of the request body. The value is application/json.
rel	String	Specifies the relationship between the current API version and the referenced address.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 7** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 9** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 11** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 404

**Table 12** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 13** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 405

**Table 14** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 15** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 406

**Table 16** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 17** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 407

**Table 18** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 19** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 408

**Table 20** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 21** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 409

**Table 22** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 23** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 500

**Table 24** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 25** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 501

**Table 26** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 27** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 502

**Table 28** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 29** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 503

**Table 30** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 31** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 504

**Table 32** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 33** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Example Requests

GET https://{endpoint}/v1

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "version":{
    {
      "updated":"2018-09-30T00:00:00Z",
      "version":"1",
      "min_version":"",
      "status":"CURRENT",
      "id":"v1",
      "links":[
        {
          "href":"https://{vpcep_uri}/v1",
          "type":"application/json",
          "rel":"self"
        }
      ]
    }
  }
}

Status Codes

Status Code	Description
200	The server has successfully processed the request.
400	The request could not be understood by the server due to malformed syntax.
401	The requested page requires a user name and password.
403	The server understood the request, but is refusing to fulfill it.
404	The requested page was not found.
405	The method specified in the request line is not allowed for the resource identified by the request URI.
406	The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
407	The client must first authenticate itself with the proxy.
408	The client did not produce a request within the time that the server was prepared to wait.
409	The request could not be completed due to a conflict with the current state of the resource.
500	Failed to complete the request. Service abnormality.
501	Failed to complete the request. The server does not support the requested function.
502	Failed to complete the request. because the server has received an invalid response.
503	Failed to complete the request. because the system is unavailable.
504	Gateway Timeout