mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
ea2c0ce229
* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
62 lines
1.7 KiB
Markdown
62 lines
1.7 KiB
Markdown
# ProbesApi
|
|
|
|
All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
|
|
|
|
| Method | HTTP request | Description |
|
|
|-----------------------|---------------------------|------------------------------------------------|
|
|
| [getProbe](#getProbe) | **GET** /probes/{probeId} | Check readiness and liveness of the repository |
|
|
|
|
## getProbe
|
|
|
|
Check readiness and liveness of the repository
|
|
|
|
> No authentication is required to call this endpoint.
|
|
> This endpoint is available in **Alfresco 6.0** and newer versions.
|
|
|
|
Returns a status of `200` to indicate success and `503` for failure.
|
|
|
|
The readiness probe is normally only used to check repository startup.
|
|
The liveness probe should then be used to check the repository is still responding to requests.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
|-------------|--------|--------------------------------------------|
|
|
| **probeId** | string | The name of the probe: `-ready-`, `-live-` |
|
|
|
|
**Return type**: [ProbeEntry](#ProbeEntry)
|
|
|
|
**Example**
|
|
|
|
```javascript
|
|
import { AlfrescoApi, ProbesApi } from '@alfresco/js-api';
|
|
|
|
const alfrescoApi = new AlfrescoApi(/*..*/);
|
|
const probesApi = new ProbesApi(alfrescoApi);
|
|
|
|
probesApi.getProbe(`<probeId>`).then((data) => {
|
|
console.log('API called successfully. Returned data: ' + data);
|
|
});
|
|
```
|
|
|
|
# Models
|
|
|
|
## ProbeEntry
|
|
|
|
**Properties**
|
|
|
|
| Name | Type |
|
|
|-------|-------------------------------------|
|
|
| entry | [ProbeEntryEntry](#ProbeEntryEntry) |
|
|
|
|
## ProbeEntryEntry
|
|
|
|
**Properties**
|
|
|
|
| Name | Type |
|
|
|-------------|--------|
|
|
| **message** | string |
|
|
|
|
|
|
|