Updated on 2026-09-22 GMT+08:00

Querying Version Information of an API

Function

This API is used to query version information of a specified API.

Authorization Information

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

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
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

-

-

-

-

-

-

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

URI

GET /{version}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
version	Yes	String	Definition API version. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
version	ApiVersionResponse object	Definition API version information.

**Table 3** ApiVersionResponse
Parameter	Type	Description
id	String	Definition API version. Range N/A
links	Array of Links objects	Definition API link information. The value is [] when the version is v3.
status	String	Definition Version status. Range CURRENT: The version has been released.
version	String	Definition Subversion information of the API version. Range N/A
min_version	String	Definition Minimum API version number. Range N/A
updated	String	Definition Version update time. The format is yyyy-mm-dd Thh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the UTC. Range N/A

**Table 4** Links
Parameter	Type	Description
href	String	Definition API URL. The value is "". Range N/A
rel	String	Definition The value is self, indicating that URL is a local link. Range N/A

Example Requests

URI example

GET https://{Endpoint}/v3

Example Responses

Status code: 200

Success

{
  "version" : {
    "id" : "v3",
    "links" : [ ],
    "status" : "CURRENT",
    "version" : "",
    "min_version" : "",
    "updated" : "2019-10-30T17:34:02Z"
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Querying API Versions