Obtención de detalles de una versión de API
Función
Esta API se utiliza para consultar los detalles de una versión de API de DSS.
URI
GET /{api_version}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
api_version |
Sí |
String |
Especifica el número de versión de destino. Para obtener el número de versión, consulte Obtención de detalles de versiones de API. |
Solicitud
Respuesta
Parámetros de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
version |
Object |
Especifica la información de la versión de la API. |
id |
String |
Especifica el ID de versión, por ejemplo v1. |
links |
Array |
Especifica la URL de la API. Para obtener más información, consulte Tabla 3. |
version |
String |
Especifica la microversión máxima admitida por esta API. |
status |
String |
Especifica el estado de la versión. El valor puede ser el siguiente: CURRENT: indica que la versión está actualmente recomendada para su uso. SUPPORTED: indica que la versión es una versión antigua, pero sigue siendo compatible. DEPRECATED: indica una versión obsoleta que puede eliminarse más tarde. |
updated |
String |
Especifica la hora en que se publicó la versión de la API. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS |
min_version |
String |
Especifica la microversión mínima admitida por esta API. |
Parámetros en el campo links
- Ejemplo de respuesta
{ "version": { "min_version": "", "links": [ { "rel": "self", "href": "https://dss.localdomain.com/v1" } ], "id": "v1", "updated": "2014-06-28T12:20:21Z", "version": "", "status": "CURRENT" } }
Valor devuelto
- Normal
- Anormal
Consulte Descripción del código de error.
Códigos de error
Consulte Códigos de error.