Help Center/ EventGrid/ API Reference/ APIs/ API Version Management/ Obtaining the API Version List

Updated on 2025-08-15 GMT+08:00

View PDF

Obtaining the API Version List

Function

This API is used to obtain the list of API versions supported by the service.

URI

GET /

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
versions	Array of versions objects	Versions.

**Table 3** versions
Parameter	Type	Description
id	String	Version number, for example, v1
links	Array of links objects	URL.
version	String	If the APIs of the given version support micro-versions, set this parameter to the supported maximum micro-version. If not, leave this parameter blank.
min_version	String	If the APIs of the given version support micro-versions, set this parameter to the supported minimum micro-version. If not, leave this parameter blank.
status	String	Version status, which can be CURRENT (recommended), SUPPORTED (earlier version that is still supported), or DEPRECATED (deprecated version, which may be deleted later).
updated	String	UTC time when the version is released.

**Table 4** links
Parameter	Type	Description
href	String	href property.
rel	String	rel property.

Example Requests

Obtain the API version list.

Example Responses

Status code: 200

Operation successful.

{
  "versions" : [ {
    "id" : "v1",
    "links" : [ {
      "href" : "https://eg.cn-north-4.myhuaweicloud.com/v1",
      "rel" : "self"
    } ],
    "version" : "",
    "min_version" : "",
    "status" : "CURRENT",
    "updated" : "2022-04-19T12:20:10Z"
  } ]
}