Fields: All Service Definitions
See the associated Services resource section for more information on how to use this resource and supported operations.
Additional references
| Type | Value | Additional information |
|---|---|---|
| Permissions resource | services | Permissions |
| Hooks filename | services.groovy | Pre- and Post-Processing Hooks |
| Tenant-supported | Yes | Tenants |
| Distinct query-supported | No | Distinct |
API version 3
| Field Name | Type | Description |
|---|---|---|
| id | String | |
| currentPhase | ServicePhase |
The service phase that will trigger a running instance of this hook definition when the service leaves the phase. |
| global | boolean | |
| includeServiceAsBody | Boolean |
If set to true, the service json body we be piped to the STDIN of the script. Defaults to false |
| name | String |
The service hook definition name. |
| nextPhase | ServicePhase |
The service phase that will trigger a running instance of this hook definition when the service enters the phase. |
| timeoutInSeconds | Long |
The duration in seconds before the hook will timeout and terminate automatically, resulting in a failure. Defaults to 900 seconds (15 minutes) when not specified. |
| transition | Transition |
The service phase transition that will trigger a running instance of this hook definition. |
| type | ServiceHookType |
The type of service hook that will be run. Before hook failures will stop the service phase transition from taking place. |
| url | String |
The executable script to be run. e.g. exec:///opt/mws/hooks/service-hooks/hook1.sh?arg1&arg2 |
| Value | Description |
|---|---|
| Deleted | |
| Terminated | |
| Cleaning | |
| Deployed | |
| Migrating | |
| Deploying | |
| Reserved | |
| Analyzing | |
| Defining | |
| Blocked | |
| Rejected |
Enumerates all the signals that a Service can respond to, which may cause a transition to a new phase of the service's lifecycle.
| Value | Description |
|---|---|
| Before | |
| After |
Related Topics