Obtaining Details of an API Version

Function

This API is used to query the details of a DSS API version.

URI

GET /{api_version}

Table 1 describes the parameter.

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
api_version	Yes	String	Specifies the target version number. For how to obtain the version number, see Obtaining Details of API Versions.

Request

Request parameters
None
Example request
The following example shows how to query version information of a v1 API.
```
GET https://{endpoint}/v1
```

Response

Response parameters

Table 2 describes the response parameters.

**Table 2** Response parameters
Parameter	Type	Description
version	Object	Specifies the API version information.
id	String	Specifies the version ID, for example, v1.
links	Array	Specifies the API URL. For details, see Table 3.
version	String	Specifies the maximum microversion supported by this API.
status	String	Specifies the version status. The value can be as follows: CURRENT: indicates that the version is currently recommended for use. SUPPORTED: indicates that the version is an old version, but is still supported. DEPRECATED: indicates a deprecated version which may be deleted later.
updated	String	Specifies the time when the API version was released. Time format: UTC YYYY-MM-DDTHH:MM:SS
min_version	String	Specifies the minimum microversion supported by this API.

Parameters in the links field

Table 3 describes the parameters in the links field.

**Table 3** Parameter description
Parameter	Type	Description
rel	String	Specifies the link description.
href	String	Specifies the version query link.

Example response

{
    "version": {
            "min_version": "", 
             "links": [
                {
                    "rel": "self", 
                    "href": "https://dss.localdomain.com/v1"
                }
            ], 
            "id": "v1", 
            "updated": "2014-06-28T12:20:21Z", 
            "version": "", 
            "status": "CURRENT"
        }
}