Querying a Specified API Version

Function

This API is used to query a specified API version. Before calling this API:

URI

GET /{version_id}

Table 1 URI parameter

Parameter

Mandatory

Type

Description

version_id

Yes

String

API version.

Values:

  • v3

  • v3.1

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameter

Parameter

Type

Description

version

Array of OpenApiVersion objects

Version details.

Table 3 OpenApiVersion

Parameter

Type

Description

id

Object

Version number, for example, v3.

links

Array of OpenApiLinks objects

API URL.

status

String

Version status.

Values:

  • CURRENT: The version is the primary version.

  • SUPPORTED: The version is an earlier version, but it is still supported.

  • DEPRECATED: The version is a deprecated version, which may be deleted later.

updated

String

Version release time in UTC. For example, the release time of v3 is 2020-10-29T03:30:42Z.

min_version

String

If the APIs of this version support microversions, the earliest microversion is returned. If not, an empty value is returned.

Table 4 OpenApiLinks

Parameter

Type

Description

href

Object

API URL. The value is "".

rel

Object

Its value is self, indicating that href is a local link.

Example Request

None

Example Response

None

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.