Help Center/ VPC Endpoint/ API Reference/ API/ Version Management/ Querying the Version of a VPC Endpoint API
Updated on 2025-05-15 GMT+08:00

Querying the Version of a VPC Endpoint API

Function

This API is used to query the version of a VPC Endpoint API.

Calling Method

For details, see Calling APIs.

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

No

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 widely used version. - SUPPORT: indicates an earlier version that is still supported. - DEPRECATED: indicates a deprecated version which may be deleted later.

id

String

Specifies the version ID.

  • v1: recommended version

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.

Example Requests

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

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.

Error Codes

See Error Codes.