Help Center/ VPC Endpoint/ API Reference/ API/ Version Management/ Querying Versions of VPC Endpoint APIs

Updated on 2025-10-28 GMT+08:00

View PDF

Querying Versions of VPC Endpoint APIs

Function

This API is used to query versions of VPC Endpoint APIs.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
vpcep::listVersionDetails	List	-	-	-	-

URI

GET /

Request Parameters

**Table 1** 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 2** Response body parameters
Parameter	Type	Description
versions	Array of VersionObject objects	Specifies the list of VPCEP versions.

**Table 3** 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.

**Table 4** 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.

Example Requests

Querying versions of VPCEP APIs

GET https://{endpoint}/

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "versions" : [ {
    "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"
    } ]
  } ]
}