Service

Changed on

Long-polling method to get the latest service deployment or service update status.<br> Required role: <b>admin</b> or <b>isv</b> or <b>user</b> </br>

get/xpanse/services/{serviceId}/deployment/status

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/xpanse/services/{serviceId}/deployment/status
  • Auth: OAuth 2 (authorization code, authorization URL https://xpanse-demo.eclipseprojects.io/oauth/v2/authorize, token URL https://xpanse-demo.eclipseprojects.io/oauth/v2/token)

Path parameters

serviceIdstring uuid required

ID of the service

Query parameters

lastKnownServiceDeploymentState'deploying' | 'deployment successful' | 'deployment failed' | 'destroying' | 'destroy successful' | 'destroy failed' | 'manual cleanup required' | 'rollback failed' | 'modifying' | 'modification failed' | 'modification successful' | 'rolling back'

Last known service status to client. When provided, the service will wait for a configured period time until to see if there is a change to the last known state.

Response

OK

serviceDeploymentState'deploying' | 'deployment successful' | 'deployment failed' | 'destroying' | 'destroy successful' | 'destroy failed' | 'manual cleanup required' | 'rollback failed' | 'modifying' | 'modification failed' | 'modification successful' | 'rolling back' required
isOrderCompletedboolean required

Describes if the deployment request is now completed

Changes

  • 93cc0c82b8b0Revision changes
    • warning

      added the new rolling back enum value to the response property for the response status

    • info

      added the new enum value rolling back to the query request parameter lastKnownServiceDeploymentState

  • 10c3487eebbcRevision changes
    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status