Operations Manager API v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
API interface to manage deployments of blueprints. HTTP Basic authorization schema is required to authenticate users for all the resource endpoints.
Base URLs:
Email: Support
Authentication
- HTTP Authentication, scheme: basic
Blueprints
Query blueprint information
List Blueprints
Code samples
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://oom-server:30129/ccsdk-app/api-if/blueprints', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X GET https://oom-server:30129/ccsdk-app/api-if/blueprints \
-H 'Accept: application/json'
GET /blueprints
Find all blueprint templates
Fetch the blueprints data from inventory
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
_include | query | array[string] | false | blueprint object properties need to be considered for filter |
Enumerated Values
Parameter | Value |
---|---|
_include | typeName |
_include | typeId |
_include | typeVersion |
Example responses
200 Response
{
"links": {
"previousLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"nextLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
}
},
"totalCount": 0,
"items": [
{
"owner": "string",
"typeName": "string",
"typeVersion": 0,
"blueprintTemplate": "string",
"serviceIds": [
"string"
],
"vnfTypes": [
"string"
],
"serviceLocations": [
"string"
],
"asdcServiceId": "string",
"asdcResourceId": "string",
"asdcServiceURL": "string",
"typeId": "string",
"selfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"deactivated": "2019-05-08T15:25:24Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | List of DCAEServiceType objects |
InlineResponse200 |
400 | Bad Request | Invalid tag value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Create Blueprint
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://oom-server:30129/ccsdk-app/api-if/blueprints', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X POST https://oom-server:30129/ccsdk-app/api-if/blueprints \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /blueprints
Create/Upload a new blueprint template
Upload a new blueprint template into inventory
Body parameter
{
"owner": "string",
"typeName": "string",
"typeVersion": 0,
"blueprintTemplate": "string",
"application": "string",
"component": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | DCAEServiceTypeRequest | true | upload blueprint request to inventory |
Example responses
200 Response
{
"links": {
"previousLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"nextLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
}
},
"totalCount": 0,
"items": [
{
"owner": "string",
"typeName": "string",
"typeVersion": 0,
"blueprintTemplate": "string",
"serviceIds": [
"string"
],
"vnfTypes": [
"string"
],
"serviceLocations": [
"string"
],
"asdcServiceId": "string",
"asdcResourceId": "string",
"asdcServiceURL": "string",
"typeId": "string",
"selfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"deactivated": "2019-05-08T15:25:24Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A DCAEServiceType object |
InlineResponse200 |
400 | Bad Request | Invalid tag value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Delete Blueprint
Code samples
import requests
r = requests.delete('https://oom-server:30129/ccsdk-app/api-if/blueprints/{typeId}', params={
)
print r.json()
# You can also use wget
curl -X DELETE https://oom-server:30129/ccsdk-app/api-if/blueprints/{typeId}
DELETE /blueprints/{typeId}
Delete a blueprint template
Delete a blueprint template from inventory
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
typeId | path | string | true | ID of blueprint to delete |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | None |
Get Deployments for a blueprint
Code samples
import requests
r = requests.get('https://oom-server:30129/ccsdk-app/api-if/blueprints/{typeId}/services', params={
)
print r.json()
# You can also use wget
curl -X GET https://oom-server:30129/ccsdk-app/api-if/blueprints/{typeId}/services
GET /blueprints/{typeId}/services
Get Services mapped to a blueprint template
Get Deployment References existing for a blueprint
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
typeId | path | string | true | ID of blueprint to query |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | None |
Get Blueprint
Code samples
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://oom-server:30129/ccsdk-app/api-if/blueprints/findByName', params={
'name': 'string'
}, headers = headers)
print r.json()
# You can also use wget
curl -X GET https://oom-server:30129/ccsdk-app/api-if/blueprints/findByName?name=string \
-H 'Accept: application/json'
GET /blueprints/findByName
Find a blueprint by a name pattern
Fetch the blueprint objects from inventory whose names match a string pattern
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
name | query | string | true | name pattern to filter by |
_include | query | array[string] | false | blueprint object properties need to be considered for filter |
Enumerated Values
Parameter | Value |
---|---|
_include | typeName |
_include | typeId |
_include | typeVersion |
Example responses
200 Response
{
"links": {
"previousLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"nextLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
}
},
"totalCount": 0,
"items": [
{
"owner": "string",
"typeName": "string",
"typeVersion": 0,
"blueprintTemplate": "string",
"serviceIds": [
"string"
],
"vnfTypes": [
"string"
],
"serviceLocations": [
"string"
],
"asdcServiceId": "string",
"asdcResourceId": "string",
"asdcServiceURL": "string",
"typeId": "string",
"selfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"deactivated": "2019-05-08T15:25:24Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | List of DCAEServiceType objects |
InlineResponse200 |
400 | Bad Request | Invalid tag value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Deployments
Manage deployments
List Deployments
Code samples
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://oom-server:30129/ccsdk-app/api-if/deployments', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X GET https://oom-server:30129/ccsdk-app/api-if/deployments \
-H 'Accept: application/json'
GET /deployments
Lists all Deployments
Query all deployments or Service objects from Inventory
Example responses
200 Response
[
{
"serviceId": "string",
"selfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"modified": "2019-05-08T15:25:24Z",
"typeLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"vnfId": "string",
"vnfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"vnfType": "string",
"vnfLocation": "string",
"deploymentRef": "string",
"components": [
{
"componentId": "string",
"componentLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"modified": "2019-05-08T15:25:24Z",
"componentType": "string",
"componentSource": "DCAEController",
"status": "string",
"location": "string",
"shareable": 0
}
],
"tenant": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | Inline |
400 | Bad Request | Invalid status value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [DCAEService] | false | none | none |
» serviceId | string | false | none | none |
» selfLink | Link | false | none | none |
»» title | string | false | none | none |
»» rel | string | false | none | none |
»» uri | string(uri) | false | none | none |
»» uriBuilder | UriBuilder | false | none | none |
»» rels | [string] | false | none | none |
»» params | object | false | none | none |
»»» additionalProperties | string | false | none | none |
»» type | string | false | none | none |
» created | string(date-time) | false | none | none |
» modified | string(date-time) | false | none | none |
» typeLink | Link | false | none | none |
» vnfId | string | false | none | none |
» vnfLink | Link | false | none | none |
» vnfType | string | false | none | none |
» vnfLocation | string | false | none | Location information of the associated VNF |
» deploymentRef | string | false | none | Reference to a Cloudify deployment |
» components | [DCAEServiceComponent] | false | none | none |
»» componentId | string | true | none | The id format is unique to the source |
»» componentLink | Link | true | none | none |
»» created | string(date-time) | true | none | none |
»» modified | string(date-time) | true | none | none |
»» componentType | string | true | none | none |
»» componentSource | string | true | none | Specifies the name of the underying source service that is responsible for this components |
»» status | string | false | none | none |
»» location | string | false | none | Location information of the component |
»» shareable | integer(int32) | true | none | Used to determine if this component can be shared amongst different DCAE services |
» tenant | string | false | none | cloudify tenant name |
Enumerated Values
Property | Value |
---|---|
componentSource | DCAEController |
componentSource | DMaaPController |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Create Deployment
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://oom-server:30129/ccsdk-app/api-if/deployments', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X POST https://oom-server:30129/ccsdk-app/api-if/deployments \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /deployments
Initiate a deployment (install) operation for an application or service
Controller sends the blueprint and required inputs to Deployment Handler microservice to initiate the deployment process
Body parameter
{
"component": "string",
"tag": "string",
"blueprintId": "string",
"blueprintName": "string",
"blueprintVersion": 0,
"tenant": "string",
"inputs": {}
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | DeploymentInput | true | Inputs to initiate a deployment: blueprint ID from inventory, Cloudify tenant name, blueprint inputs |
Example responses
200 Response
{
"deployment_id": "string",
"links": {
"self": "string",
"outcome": "string",
"status": "string"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | DeploymentResource |
401 | Unauthorized | Authentication information is missing or invalid | None |
405 | Method Not Allowed | Invalid input | None |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Delete Deployment
Code samples
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}', params={
'tenant': 'string'
}, headers = headers)
print r.json()
# You can also use wget
curl -X DELETE https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}?tenant=string \
-H 'Accept: application/json'
DELETE /deployments/{deploymentId}
Initiate an uninstall operation for an application or service
Controller sends the deployment reference to Deployment Handler microservice to initiate the uninstall process
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of deployment to query |
tenant | query | string | true | Cloudify Tenant name |
Example responses
200 Response
"string"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | string |
400 | Bad Request | Invalid status value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Upgrade_Rollback Deployment
Code samples
import requests
headers = {
'Content-Type': 'application/json'
}
r = requests.put('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X PUT https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId} \
-H 'Content-Type: application/json'
PUT /deployments/{deploymentId}
Upgrade or Rollback an existing deployment using Cloudify Helm plugin
Upgrade or Rollback an existing deployment using Cloudify Helm plugin
Body parameter
{
"chartVersion": "string",
"chartRepo": "string",
"config_url": "string",
"config_format": "string",
"tenant": "string",
"workflow": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of deployment in context |
body | body | CloudifyDeploymentUpgradeRequest | true | Cloudify Execution Request object that has parameters to start either an upgrade or a rollback execution workflow |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
400 | Bad Request | Invalid ID supplied | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
404 | Not Found | Deployment not found | None |
405 | Method Not Allowed | Validation exception | None |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Get Deployment
Code samples
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X GET https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId} \
-H 'Accept: application/json'
GET /deployments/{deploymentId}
Gets a Deployment
Query a deployment or Service object from Inventory
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of deployment to query |
Example responses
200 Response
[
{
"serviceId": "string",
"selfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"modified": "2019-05-08T15:25:24Z",
"typeLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"vnfId": "string",
"vnfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"vnfType": "string",
"vnfLocation": "string",
"deploymentRef": "string",
"components": [
{
"componentId": "string",
"componentLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"modified": "2019-05-08T15:25:24Z",
"componentType": "string",
"componentSource": "DCAEController",
"status": "string",
"location": "string",
"shareable": 0
}
],
"tenant": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | Inline |
400 | Bad Request | Invalid status value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [DCAEService] | false | none | none |
» serviceId | string | false | none | none |
» selfLink | Link | false | none | none |
»» title | string | false | none | none |
»» rel | string | false | none | none |
»» uri | string(uri) | false | none | none |
»» uriBuilder | UriBuilder | false | none | none |
»» rels | [string] | false | none | none |
»» params | object | false | none | none |
»»» additionalProperties | string | false | none | none |
»» type | string | false | none | none |
» created | string(date-time) | false | none | none |
» modified | string(date-time) | false | none | none |
» typeLink | Link | false | none | none |
» vnfId | string | false | none | none |
» vnfLink | Link | false | none | none |
» vnfType | string | false | none | none |
» vnfLocation | string | false | none | Location information of the associated VNF |
» deploymentRef | string | false | none | Reference to a Cloudify deployment |
» components | [DCAEServiceComponent] | false | none | none |
»» componentId | string | true | none | The id format is unique to the source |
»» componentLink | Link | true | none | none |
»» created | string(date-time) | true | none | none |
»» modified | string(date-time) | true | none | none |
»» componentType | string | true | none | none |
»» componentSource | string | true | none | Specifies the name of the underying source service that is responsible for this components |
»» status | string | false | none | none |
»» location | string | false | none | Location information of the component |
»» shareable | integer(int32) | true | none | Used to determine if this component can be shared amongst different DCAE services |
» tenant | string | false | none | cloudify tenant name |
Enumerated Values
Property | Value |
---|---|
componentSource | DCAEController |
componentSource | DMaaPController |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Update Deployment
Code samples
import requests
headers = {
'Content-Type': 'application/json'
}
r = requests.put('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/update', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X PUT https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/update \
-H 'Content-Type: application/json'
PUT /deployments/{deploymentId}/update
Update an existing deployment
Dispatch a request to Deployment handler mS to use Cloudify deployment update operation
Body parameter
{
"component": "string",
"tag": "string",
"blueprintId": "string",
"blueprintName": "string",
"blueprintVersion": 0,
"tenant": "string",
"inputs": {}
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of deployment to update |
body | body | DeploymentInput | true | Inputs to initiate a deployment: blueprint ID from inventory, Cloudify tenant name, blueprint inputs |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
400 | Bad Request | Invalid ID supplied | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
404 | Not Found | Deployment not found | None |
405 | Method Not Allowed | Validation exception | None |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Deployment Status
Code samples
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/executions', params={
'tenant': 'string'
}, headers = headers)
print r.json()
# You can also use wget
curl -X GET https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/executions?tenant=string \
-H 'Accept: application/json'
GET /deployments/{deploymentId}/executions
Deployment execution status
Query deployment workflow execution status
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of deployment to query execution status |
tenant | query | string | true | tenant name associated with the deployment |
Example responses
200 Response
[
{
"created_at": "string",
"deployment_id": "string",
"id": "string",
"status": "string",
"workflow_id": "string",
"tenant_name": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | Inline |
400 | Bad Request | Invalid status value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [execution] | false | none | none |
» created_at | string | false | none | The time the execution was queued at |
» deployment_id | string | false | none | The id of the deployment the execution is in the context of |
» id | string | false | none | A unique identifier for the execution |
» status | string | false | none | The executions status |
» workflow_id | string | false | none | The id/name of the workflow the execution is of |
» tenant_name | string | false | none | Cloudify tenant name where the deployment was done |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Deployment Inputs
Code samples
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/inputs', params={
'tenant': 'string'
}, headers = headers)
print r.json()
# You can also use wget
curl -X GET https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/inputs?tenant=string \
-H 'Accept: application/json'
GET /deployments/{deploymentId}/inputs
Deployment inputs
Get blueprint inputs used to create deployment
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of deployment to query execution status |
tenant | query | string | true | tenant name associated with the deployment |
Example responses
200 Response
{}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | Inline |
400 | Bad Request | Invalid status value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Schema
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Tenants
Query Cloudify Tenants
List Tenants
Code samples
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://oom-server:30129/ccsdk-app/api-if/tenants', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X GET https://oom-server:30129/ccsdk-app/api-if/tenants \
-H 'Accept: application/json'
GET /tenants
Lists all Cloudify Tenants
Query all Tenant names from Cloudify
Example responses
200 Response
[
{
"name": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | Inline |
400 | Bad Request | Invalid status value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [Tenant] | false | none | none |
» name | string | false | none | cloudify tenant name |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Components
Query on-boarded components
List Components
Code samples
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://oom-server:30129/ccsdk-app/api-if/components', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X GET https://oom-server:30129/ccsdk-app/api-if/components \
-H 'Accept: application/json'
GET /components
Lists all application components
Query all components from database
Example responses
200 Response
[
{
"compId": 0,
"cname": "string",
"dname": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | Inline |
400 | Bad Request | Invalid status value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [Component] | false | none | none |
» compId | integer | false | none | none |
» cname | string | false | none | component namespace name |
» dname | string | false | none | component display name |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Add Component
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': '*/*'
}
r = requests.post('https://oom-server:30129/ccsdk-app/api-if/components', params={
}, headers = headers)
print r.json()
# You can also use wget
curl -X POST https://oom-server:30129/ccsdk-app/api-if/components \
-H 'Content-Type: application/json' \
-H 'Accept: */*'
POST /components
add an application component
Insert a component into database
Body parameter
{
"cname": "string",
"dname": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | ComponentInput | true | New component input |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | successful operation | Inline |
400 | Bad Request | Invalid status value | None |
401 | Unauthorized | Authentication information is missing or invalid | None |
Response Schema
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
401 | WWW_Authenticate | string | none |
Schemas
Tenant
{
"name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | cloudify tenant name |
Component
{
"compId": 0,
"cname": "string",
"dname": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
compId | integer | false | none | none |
cname | string | false | none | component namespace name |
dname | string | false | none | component display name |
ComponentInput
{
"cname": "string",
"dname": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
cname | string | false | none | component namespace name |
dname | string | false | none | component display name |
InlineResponse200
{
"links": {
"previousLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"nextLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
}
},
"totalCount": 0,
"items": [
{
"owner": "string",
"typeName": "string",
"typeVersion": 0,
"blueprintTemplate": "string",
"serviceIds": [
"string"
],
"vnfTypes": [
"string"
],
"serviceLocations": [
"string"
],
"asdcServiceId": "string",
"asdcResourceId": "string",
"asdcServiceURL": "string",
"typeId": "string",
"selfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"deactivated": "2019-05-08T15:25:24Z"
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
links | InlineResponse200Links | false | none | Pagination links |
totalCount | integer(int32) | false | none | none |
items | [DCAEServiceType] | false | none | none |
InlineResponse200Links
{
"previousLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"nextLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
}
}
Pagination links
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
previousLink | Link | false | none | none |
nextLink | Link | false | none | none |
ApiResponseMessage
{
"code": 0,
"type": "string",
"message": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | integer(int32) | false | none | none |
type | string | false | none | none |
message | string | false | none | none |
DCAEService
{
"serviceId": "string",
"selfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"modified": "2019-05-08T15:25:24Z",
"typeLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"vnfId": "string",
"vnfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"vnfType": "string",
"vnfLocation": "string",
"deploymentRef": "string",
"components": [
{
"componentId": "string",
"componentLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"modified": "2019-05-08T15:25:24Z",
"componentType": "string",
"componentSource": "DCAEController",
"status": "string",
"location": "string",
"shareable": 0
}
],
"tenant": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
serviceId | string | false | none | none |
selfLink | Link | false | none | Link.title is serviceId |
created | string(date-time) | false | none | none |
modified | string(date-time) | false | none | none |
typeLink | Link | false | none | Link.title is typeId |
vnfId | string | false | none | none |
vnfLink | Link | false | none | Link.title is vnfId |
vnfType | string | false | none | none |
vnfLocation | string | false | none | Location information of the associated VNF |
deploymentRef | string | false | none | Reference to a Cloudify deployment |
components | [DCAEServiceComponent] | false | none | none |
tenant | string | false | none | cloudify tenant name |
InlineResponse2001
{
"links": {
"previousLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"nextLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
}
},
"totalCount": 0,
"items": [
{
"serviceId": "string",
"selfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"modified": "2019-05-08T15:25:24Z",
"typeLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"vnfId": "string",
"vnfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"vnfType": "string",
"vnfLocation": "string",
"deploymentRef": "string",
"components": [
{
"componentId": "string",
"componentLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"modified": "2019-05-08T15:25:24Z",
"componentType": "string",
"componentSource": "DCAEController",
"status": "string",
"location": "string",
"shareable": 0
}
],
"tenant": "string"
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
links | InlineResponse200Links | false | none | Pagination links |
totalCount | integer(int32) | false | none | none |
items | [DCAEService] | false | none | none |
UriBuilder
{}
Properties
None
Link
{
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
title | string | false | none | none |
rel | string | false | none | none |
uri | string(uri) | false | none | none |
uriBuilder | UriBuilder | false | none | none |
rels | [string] | false | none | none |
params | object | false | none | none |
» additionalProperties | string | false | none | none |
type | string | false | none | none |
DCAEServiceComponent
{
"componentId": "string",
"componentLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"modified": "2019-05-08T15:25:24Z",
"componentType": "string",
"componentSource": "DCAEController",
"status": "string",
"location": "string",
"shareable": 0
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
componentId | string | true | none | The id format is unique to the source |
componentLink | Link | true | none | Link to the underlying resource of this component |
created | string(date-time) | true | none | none |
modified | string(date-time) | true | none | none |
componentType | string | true | none | none |
componentSource | string | true | none | Specifies the name of the underying source service that is responsible for this components |
status | string | false | none | none |
location | string | false | none | Location information of the component |
shareable | integer(int32) | true | none | Used to determine if this component can be shared amongst different DCAE services |
Enumerated Values
Property | Value |
---|---|
componentSource | DCAEController |
componentSource | DMaaPController |
DCAEServiceTypeRequest
{
"owner": "string",
"typeName": "string",
"typeVersion": 0,
"blueprintTemplate": "string",
"application": "string",
"component": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
owner | string | true | none | none |
typeName | string | true | none | Descriptive name for this DCAE service type |
typeVersion | integer(int32) | true | none | Version number for this DCAE service type |
blueprintTemplate | string | true | none | String representation of a Cloudify blueprint with unbound variables |
application | string | true | none | controller application name |
component | string | true | none | onboarding component name |
DCAEServiceType
{
"owner": "string",
"typeName": "string",
"typeVersion": 0,
"blueprintTemplate": "string",
"serviceIds": [
"string"
],
"vnfTypes": [
"string"
],
"serviceLocations": [
"string"
],
"asdcServiceId": "string",
"asdcResourceId": "string",
"asdcServiceURL": "string",
"typeId": "string",
"selfLink": {
"title": "string",
"rel": "string",
"uri": "http://example.com",
"uriBuilder": {},
"rels": [
"string"
],
"params": {
"property1": "string",
"property2": "string"
},
"type": "string"
},
"created": "2019-05-08T15:25:24Z",
"deactivated": "2019-05-08T15:25:24Z"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
owner | string | true | none | none |
typeName | string | true | none | Descriptive name for this DCAE service type |
typeVersion | integer(int32) | true | none | Version number for this DCAE service type |
blueprintTemplate | string | true | none | String representation of a Cloudify blueprint with unbound variables |
serviceIds | [string] | false | none | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id. |
vnfTypes | [string] | false | none | none |
serviceLocations | [string] | false | none | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location. |
asdcServiceId | string | false | none | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field serviceInvariantUUID . |
asdcResourceId | string | false | none | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field resourceInvariantUUID . |
asdcServiceURL | string | false | none | URL to the ASDC service model |
typeId | string | true | none | Unique identifier for this DCAE service type |
selfLink | Link | true | none | Link to self where the Link.title is typeName |
created | string(date-time) | true | none | Created timestamp for this DCAE service type in epoch time |
deactivated | string(date-time) | false | none | Deactivated timestamp for this DCAE service type in epoch time |
CloudifyDeploymentUpgradeRequest
{
"chartVersion": "string",
"chartRepo": "string",
"config_url": "string",
"config_format": "string",
"tenant": "string",
"workflow": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
chartVersion | string | true | none | Helm package version used for install |
chartRepo | string | true | none | Helm repository URL for the chart |
config_url | string | true | none | Helm repository URL for the chart values to update |
config_format | string | true | none | yaml format or json format |
tenant | string | true | none | cloudify tenant name for the deployment upgrade |
workflow | string | true | none | input values are upgrade or rollback - helm upgrade workflow or helm rollback workflow |
DeploymentInput
{
"component": "string",
"tag": "string",
"blueprintId": "string",
"blueprintName": "string",
"blueprintVersion": 0,
"tenant": "string",
"inputs": {}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
component | string | true | none | component or namespace for the service |
tag | string | true | none | tag to identify the deployment |
blueprintId | string | false | none | typeId from inventory, a unique Id for the blueprint |
blueprintName | string | true | none | Descriptive name for this DCAE service type |
blueprintVersion | integer(int32) | false | none | Version number for this DCAE service type, optional. Defaults to latest version. |
tenant | string | true | none | cloudify tenant name |
inputs | object | true | none | JSON object containing the input parameter names and values |
deploymentInputs
{}
Properties
None
execution
{
"created_at": "string",
"deployment_id": "string",
"id": "string",
"status": "string",
"workflow_id": "string",
"tenant_name": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
created_at | string | false | none | The time the execution was queued at |
deployment_id | string | false | none | The id of the deployment the execution is in the context of |
id | string | false | none | A unique identifier for the execution |
status | string | false | none | The executions status |
workflow_id | string | false | none | The id/name of the workflow the execution is of |
tenant_name | string | false | none | Cloudify tenant name where the deployment was done |
DeploymentResourceLinks
{
"self": "string",
"outcome": "string",
"status": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
self | string | false | none | Link to retrieve information about the service being deployed |
outcome | string | false | none | Link to retrieve information about deployment outcome |
status | string | false | none | Link to retrieve information about the status of the installation workflow |
DeploymentResource
{
"deployment_id": "string",
"links": {
"self": "string",
"outcome": "string",
"status": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
deployment_id | string | false | none | unique ID for the deployment resource |
links | DeploymentResourceLinks | false | none | Links that the API client can access |