Sign in
Service

Changed on

Get service template details by service id.<br> Required role: <b>admin</b> or <b>isv</b> or <b>user</b> </br>

get/xpanse/services/{serviceId}/service_template

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/xpanse/services/{serviceId}/service_template
  • 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

The id of deployed service.

Response

OK

serviceTemplateIdstring uuid required

The id of the orderable service.

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

The name of the orderable service.

shortCodestring required

Short code of the service.

versionstring required

The version of the orderable service.

csp'HuaweiCloud' | 'FlexibleEngine' | 'OpenstackTestlab' | 'PlusServer' | 'RegioCloud' | 'AlibabaCloud' | 'aws' | 'azure' | 'GoogleCloudPlatform' required
serviceVendorstring required

The serviceVendor of the orderable service.

descriptionstring required

The description of the orderable service.

iconstring required

The icon of the orderable service.

serviceHostingType'self' | 'service-vendor' required

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

eulastring

End user license agreement content of the service.

Example response

{
  "serviceActions": [
    {
      "actionManageScripts": [
        {
          "ansibleScriptConfig": {
            "playbookName": "playbook-name.yml",
            "virtualEnv": "/tmp/virtualEnv",
            "pythonVersion": "3.10",
            "requirementsFile": "modules/requirements.txt"
          }
        }
      ]
    }
  ],
  "serviceObjects": [
    {
      "objectsManage": [
        {
          "objectHandlerScript": {
            "ansibleScriptConfig": {
              "playbookName": "playbook-name.yml",
              "virtualEnv": "/tmp/virtualEnv",
              "pythonVersion": "3.10",
              "requirementsFile": "modules/requirements.txt"
            }
          }
        }
      ]
    }
  ]
}

Changes

  • eca4be214042Revision changes
    • info

      added the required property to the response with the status

  • 93cc0c82b8b0Revision changes
    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the //// response's property type changed from object to no type for status

    • breaking

      the ////// response's property type changed from object to no type for status

    • breaking

      the /////// response's property type changed from object to no type for status