Service

Changed on

List all deployed services belongs to the user.<br> Required role: <b>admin</b> or <b>user</b> </br>

get/xpanse/services

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/xpanse/services
  • 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)

Query parameters

categoryName'ai' | 'compute' | 'container' | 'storage' | 'network' | 'database' | 'mediaService' | 'security' | 'middleware' | 'others'

category of the service

cspName'HuaweiCloud' | 'FlexibleEngine' | 'OpenstackTestlab' | 'PlusServer' | 'RegioCloud' | 'AlibabaCloud' | 'aws' | 'azure' | 'GoogleCloudPlatform'

name of the cloud service provider

serviceNamestring

name of the service

serviceVersionstring

version of the service

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

deployment state of the service

Response

OK

serviceIdstring uuid required

The ID of the service

category'ai' | 'compute' | 'container' | 'storage' | 'network' | 'database' | 'mediaService' | 'security' | 'middleware' | 'others' required
namestring required

The name of the service

customerServiceNamestring

Customer's name for the service. Used only for customer's reference.If not provided, this value will be auto-generated

versionstring required

The version of the service

csp'HuaweiCloud' | 'FlexibleEngine' | 'OpenstackTestlab' | 'PlusServer' | 'RegioCloud' | 'AlibabaCloud' | 'aws' | 'azure' | 'GoogleCloudPlatform' required
serviceHostingType'self' | 'service-vendor' required

Defines which cloud service account is used for deploying cloud resources.

availabilityZonesobject

The availability zones of the service

flavorstring required

The flavor of the service

billingMode'Fixed' | 'Pay per Use' required
inputPropertiesobject

The input properties to deploy the service.

deployedServicePropertiesobject

The properties of the deployed service.

serviceTemplateIdstring uuid required

The id of the Service Template

userIdstring

The id of the user who deployed the service.

serviceDeploymentState'deploying' | 'deployment successful' | 'deployment failed' | 'destroying' | 'destroy successful' | 'destroy failed' | 'manual cleanup required' | 'rollback failed' | 'modifying' | 'modification failed' | 'modification successful' | 'rolling back' required
serviceState'not running' | 'running' | 'starting' | 'stopping' | 'stopped' | 'restarting' | 'unknown' required
createdTimestring date-time required

Time of register service.

lastModifiedTimestring date-time required

Time of update service.

lastStartedAtstring date-time

Time of start service.

lastStoppedAtstring date-time

Time of stop service.

Changes

  • 93cc0c82b8b0Revision changes
    • warning

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

    • warning

      added the new unknown enum value to the / response property for the response status

    • info

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

  • 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