/read-only-mode/create-schedule/sqlserver
- Vijayganesh Sivaprakasam
Create READ ONLY mode schedule
Request
HTTP Method: POST
Content Type: application/json
Parameters
Property | Type | Description | Required |
|---|---|---|---|
| integer(int64) | configuration ID (non-negative) | required |
| string | cron expression specifying when to activate READ ONLY mode |
|
| integer | duration of READ ONLY mode, in minutes |
|
| string | name of schedule (optional) |
|
| string | directory in which to create standby file |
|
{
"params": {
"configuration_id": 1,
"cron_expression": "string",
"duration": 123,
"schedule_name": "string",
"standby_file_directory": "string"
}
}Response
HTTP Status: 200
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| object of type | read-only-mode/create-schedule/sqlserver response |
| boolean | response with error or not |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
read_only_mode_create_schedule_sqlserver_response
Property | Type | Description |
|---|---|---|
| boolean | whether the scheduled READ ONLY mode feature is enabled |
| object of type | READ ONLY mode schedule details |
| string | directory in which to create standby file |
schedule
Property | Type | Description |
|---|---|---|
| string | cron expression specifying when to activate READ ONLY mode |
| integer | duration of READ ONLY mode, in minutes |
| boolean | whether the schedule is active |
| string | READ ONLY mode schedule ID |
| string | name of schedule |
{
"error": {
"message": "string"
},
"result": {
"enabled": false,
"schedule": {
"cron_expression": "string",
"duration_in_minutes": 123,
"is_active": false,
"schedule_id": "string",
"schedule_name": "string"
},
"standby_file_directory": "string"
},
"successful": true
}HTTP Status: 400
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| boolean | always false |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
{
"error": {
"message": "string"
},
"successful": false
}