1. Overview
1.1. Version information
Version : 4.1.2-SNAPSHOT
1.2. URI scheme
Host : localhost:34219
BasePath : /restservices/clds/
Schemes : HTTP
2. Paths
2.1. GET /v1/clds/cldsInfo
2.1.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.1.2. Produces
-
application/json
2.2. GET /v1/healthcheck
2.2.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.2.2. Produces
-
application/json
2.3. GET /v1/user/getUser
2.3.1. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.3.2. Produces
-
text/plain
2.4. PUT /v2/loop/delete/{loopName}
2.4.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.4.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.5. PUT /v2/loop/deploy/{loopName}
2.5.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.5.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.5.3. Produces
-
application/json
2.6. GET /v2/loop/getAllNames
2.6.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
< string > array |
2.6.2. Produces
-
application/json
2.7. GET /v2/loop/getstatus/{loopName}
2.7.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.7.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.7.3. Produces
-
application/json
2.8. PUT /v2/loop/restart/{loopName}
2.8.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.8.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.8.3. Produces
-
application/json
2.9. PUT /v2/loop/stop/{loopName}
2.9.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.9.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.9.3. Produces
-
application/json
2.10. PUT /v2/loop/submit/{loopName}
2.10.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.10.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.10.3. Produces
-
application/json
2.11. GET /v2/loop/svgRepresentation/{loopName}
2.11.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.11.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
string |
2.11.3. Produces
-
application/xml
2.12. PUT /v2/loop/undeploy/{loopName}
2.12.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.12.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.12.3. Produces
-
application/json
2.13. POST /v2/loop/updateGlobalProperties/{loopName}
2.13.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
Body |
body |
2.13.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.13.3. Consumes
-
application/json
2.13.4. Produces
-
application/json
2.14. POST /v2/loop/updateMicroservicePolicy/{loopName}
2.14.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
Body |
body |
2.14.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.14.3. Consumes
-
application/json
2.14.4. Produces
-
application/json
2.15. POST /v2/loop/updateOperationalPolicies/{loopName}
2.15.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
Body |
body |
2.15.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.15.3. Consumes
-
application/json
2.15.4. Produces
-
application/json
2.16. GET /v2/loop/{loopName}
2.16.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.16.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.16.3. Produces
-
application/json
3. Definitions
3.1. CldsHealthCheck
Name | Schema |
---|---|
description |
string |
healthCheckComponent |
string |
healthCheckStatus |
string |
3.2. CldsInfo
Name | Schema |
---|---|
cldsVersion |
string |
permissionReadCl |
boolean |
permissionReadTemplate |
boolean |
permissionReadTosca |
boolean |
permissionUpdateCl |
boolean |
permissionUpdateTemplate |
boolean |
permissionUpdateTosca |
boolean |
userName |
string |
3.3. ExternalComponent
Name | Schema |
---|---|
componentName |
string |
state |
3.4. ExternalComponentState
Name | Schema |
---|---|
description |
string |
level |
integer (int32) |
stateName |
string |
3.5. JsonArray
Name | Schema |
---|---|
asBigDecimal |
number |
asBigInteger |
integer |
asBoolean |
boolean |
asByte |
string (byte) |
asCharacter |
string |
asDouble |
number (double) |
asFloat |
number (float) |
asInt |
integer (int32) |
asJsonArray |
|
asJsonNull |
|
asJsonObject |
|
asJsonPrimitive |
|
asLong |
integer (int64) |
asNumber |
|
asShort |
integer (int32) |
asString |
string |
jsonArray |
boolean |
jsonNull |
boolean |
jsonObject |
boolean |
jsonPrimitive |
boolean |
3.6. JsonNull
Name | Schema |
---|---|
asBigDecimal |
number |
asBigInteger |
integer |
asBoolean |
boolean |
asByte |
string (byte) |
asCharacter |
string |
asDouble |
number (double) |
asFloat |
number (float) |
asInt |
integer (int32) |
asJsonArray |
|
asJsonNull |
|
asJsonObject |
|
asJsonPrimitive |
|
asLong |
integer (int64) |
asNumber |
|
asShort |
integer (int32) |
asString |
string |
jsonArray |
boolean |
jsonNull |
boolean |
jsonObject |
boolean |
jsonPrimitive |
boolean |
3.7. JsonObject
Name | Schema |
---|---|
asBigDecimal |
number |
asBigInteger |
integer |
asBoolean |
boolean |
asByte |
string (byte) |
asCharacter |
string |
asDouble |
number (double) |
asFloat |
number (float) |
asInt |
integer (int32) |
asJsonArray |
|
asJsonNull |
|
asJsonObject |
|
asJsonPrimitive |
|
asLong |
integer (int64) |
asNumber |
|
asShort |
integer (int32) |
asString |
string |
jsonArray |
boolean |
jsonNull |
boolean |
jsonObject |
boolean |
jsonPrimitive |
boolean |
3.8. JsonPrimitive
Name | Schema |
---|---|
asBigDecimal |
number |
asBigInteger |
integer |
asBoolean |
boolean |
asByte |
string (byte) |
asCharacter |
string |
asDouble |
number (double) |
asFloat |
number (float) |
asInt |
integer (int32) |
asJsonArray |
|
asJsonNull |
|
asJsonObject |
|
asJsonPrimitive |
|
asLong |
integer (int64) |
asNumber |
|
asShort |
integer (int32) |
asString |
string |
boolean |
boolean |
jsonArray |
boolean |
jsonNull |
boolean |
jsonObject |
boolean |
jsonPrimitive |
boolean |
number |
boolean |
string |
boolean |
3.9. Loop
Name | Schema |
---|---|
blueprint |
string |
components |
< string, ExternalComponent > map |
dcaeBlueprintId |
string |
dcaeDeploymentId |
string |
dcaeDeploymentStatusUrl |
string |
globalPropertiesJson |
|
lastComputedState |
enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING) |
loopLogs |
< LoopLog > array |
microServicePolicies |
< MicroServicePolicy > array |
modelPropertiesJson |
|
name |
string |
operationalPolicies |
< OperationalPolicy > array |
svgRepresentation |
string |
3.10. LoopLog
Name | Schema |
---|---|
id |
integer (int64) |
logComponent |
string |
logInstant |
integer (int64) |
logType |
enum (INFO, WARNING, ERROR) |
loop |
|
message |
string |
3.11. MicroServicePolicy
Name | Schema |
---|---|
jsonRepresentation |
|
modelType |
string |
name |
string |
policyTosca |
string |
properties |
|
shared |
boolean |
usedByLoops |
< Loop > array |
3.12. Number
Type : object
3.13. OperationalPolicy
Name | Schema |
---|---|
configurationsJson |
|
jsonRepresentation |
|
loop |
|
name |
string |