Update a Service's state
/apiplatform/management/v1/services/{serviceId}/state
Updates the state of the {serviceId}
service. Valid states are ACTIVE
and INACTIVE
(notice that state values are all uppercase).
Users requesting this resource must be assigned the Service Manager roles and must be issued the Manage Service grant for the specified service.
Request
- application/json
-
serviceId: string
A unique ID referencing a specific service.
object
-
state:
string
The updated service state.
ACTIVE
indicates it can be referenced in policies;INACTIVE
indicates it can't be referenced in policies. -
stateComments(optional):
string
Comments about the service's state.
Response
- application/json
204 Response
400 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
403 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to update the state of the specified service by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X PUT
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @servicestate-put.json
https://example.com/apiplatform/management/v1/services/{serviceId}/state
where {serviceId}
is a unique Id of a specific service. See Get Services.
Example of Request Body
The following shows an example of the request body, included with the request above in a file named servicestate-put.json
.
{ state: "INACTIVE", stateComments: "scheduled downtime" }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Sun, 22 Oct 2017 08:34:10 GMT X-oracle-dms-ecid: 49d14691-2176-4c99-aed3-38438604f528-00001e4e X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0