View deployment details
/apiplatform/management/v1/apis/{apiId}/deployments/{depId}
Returns details for the {depId}
deployment of the {apiId}
the API. The response also contains HATEOAS links to related operations.
Users requesting this resource must be assigned the Plan Manager, API Manager, or Gateway Manager role and must be issued the Manage API or View All Details grants for the specified API.
Request
- application/json
-
apiId: string
A unique ID referencing a specific API.
-
depId: string
A unique ID referencing a specific deployment.
-
expand(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of expand values. -
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. - links(optional): array
Response
- application/json
200 Response
object
-
links(optional):
array links
Includes 'canonical'.
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
object
-
action(optional):
string
The deployment action. Valid values are
DEPLOY
(to create a new deployment),UNDEPLOY
(to undeploy a deployment),ACTIVATE
(to activate a deployment), andINACTIVATE
(to inactivate a deployment). -
deploymentComments(optional):
string
Comments regarding the deployment's state.
-
deploymentState(optional):
string
The deployment's state. Valid values are
REQUESTING
,APPROVED
, andREJECTED
. -
description(optional):
string
The deployment's description.
-
endpoints(optional):
array endpoints
The deployment's endpoints.
-
runtimeState(optional):
string
The deployment's runtime state. Valid values are
ACTIVE
andINACTIVE
.
object
-
createdAt(optional):
string
The date and time the deployment was created.
-
createdBy(optional):
string
The user who created the deployment.
-
updatedAt(optional):
string
The date and time the deployment was last updated.
-
updatedBy(optional):
string
The user who last updated the deployment.
object
object
-
configuration(optional):
object configuration
-
description(optional):
string
The gateway's description.
-
firewall(optional):
object firewall
-
location(optional):
string
The gateway's location.
-
proxyUrls(optional):
array proxyUrls
-
releaseVersion(optional):
string
The gateway's release version. This property is used only at node registration time to seed the original release version of the node.
-
urls(optional):
array urls
object
-
createdAt(optional):
string
The date and time the gateway was created.
-
createdBy(optional):
string
The user who created the gateway.
-
updatedAt(optional):
string
The date time the gateway was last updated.
-
updatedBy(optional):
string
The user who last updated the gateway.
object
-
deploymentState(optional):
string
The node deployment's state.
-
endpoints(optional):
array endpoints
The node deployment's endpoints.
-
errorMessage(optional):
string
The deployment's error message.
-
errorSummary(optional):
string
The deployment's error summary.
-
id(optional):
string
The node id.
-
name(optional):
string
The node name.
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 retrieve details of a deployment by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/apis/{apiId}/deployments/{depId}
-
{apiId}
is the unique ID for an API. To retrieve available API IDs, see Get APIs. -
{depId}
is the unique ID for a deployment. To retrieve available deployment IDs, see Get API deployments.
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Fri, 17 Mar 2017 07:39:55 GMT Content-Length: 1495 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0002afb5 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including ID of the deployment, application, iteration and gateway. The response also contains HATEOAS links to related operations:
{ "endpoints": [ "http://example.com:8001/exampleEndpoint" ], "updatedBy": "apicsadmin", "runtimeState": "ACTIVE", "deploymentState": "APPROVED", "createdAt": "2017-03-16T23:33:51-0700", "nodes": [ { "deploymentState": "DEPLOYED", "endpoints": [ "http://example.com:8001/exampleEndpoint" ], "id": "100" } ], "createdBy": "apicsadmin", "action": "DEPLOY", "links": [ { "templated": "true", "method": "GET", "rel": "canonical", "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments/103" }, { "templated": "true", "method": "GET", "rel": "implementation", "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments/103/api" }, { "templated": "true", "method": "POST", "rel": "deploy", "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments" }, { "templated": "true", "method": "POST", "rel": "redeploy", "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments" }, { "templated": "true", "method": "POST", "rel": "activate", "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments" }, { "templated": "true", "method": "POST", "rel": "inactivate", "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments" }, { "templated": "true", "method": "POST", "rel": "undeploy", "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments" } ], "id": "103", "api": { "id": "103", "iterationId": "3" }, "gateway": { "id": "100" }, "updatedAt": "2017-03-16T23:33:51-0700" }