View Actions
Details
API Details | Release-Specific Information | |||
---|---|---|---|---|
CloudCenter Platform 4x | CloudCenter Suite 5x | |||
Name | View Actions | |||
Description | View an action or a list of actions as described in Actions Library – you can also use this API to retrieve system-defined actions by setting the includeSystemDefinedActions attribute to true | |||
Allowed Role(s) | WM_USER | |||
Method | GET | |||
URI |
|
| ||
Sample Request | curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/actions" | curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/actions" | ||
Release |
| Modified in CloudCenter Suite 5.0.0 | ||
Notes |
| |||
Back To Links | CloudCenter Platform 4x API | Workload Manager API | ||
ESB Header |
See the Enterprise Service Bus (ESB) section for additional context. | Not applicable |
Example 1 Response
{ "resource":null, "size":11, "pageNumber":0, "totalElements":11, "totalPages":1, "actionJaxbs":[ { "id":"17", "resource":"https://<HOST>:<PORT>/v1/actions/17", "perms":[ "delete", "read", "write", "administration" ], "name":"Add Tetration Sensor", "description":"", "actionType":"EXECUTE_COMMAND", "lastUpdatedTime":"2017-03-04 00:28:57.023", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":false, "bulkOperationSupported":true, "isAvailableToUser":true, "owner":2, "actionParameters":[ { "paramName":"downloadFromBundle", "paramValue":"true", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"bundlePath", "paramValue":"https://dummy.com/", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"script", "paramValue":"https://dummy.com/", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"executeOnContainer", "paramValue":"true", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"rebootInstance", "paramValue":"false", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"refreshInstanceInfo", "paramValue":"false", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"refreshInstanceInfo", "paramValue":"false", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" } ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"IMPORTED_VM", "appProfiles":[ ], "cloudRegions":[ "all" ], "cloudAccounts":[ "all" ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"18", "resource":"https://<HOST>:<PORT>/v1/actions/18", "perms":[ "delete", "read", "write", "administration" ], "name":"custome-action-1", "description":"custome-action-1", "actionType":"EXECUTE_COMMAND", "lastUpdatedTime":"2017-04-27 17:42:58.347", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":false, "bulkOperationSupported":true, "isAvailableToUser":true, "owner":2, "actionParameters":[ { "paramName":"downloadFromBundle", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"script", "paramValue":"echo \"custome-action-1\"", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"executeOnContainer", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"rebootInstance", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"refreshInstanceInfo", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"refreshInstanceInfo", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" } ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ "all" ], "cloudRegions":[ "all" ], "cloudAccounts":[ "all" ], "services":[ "all" ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"34", "resource":"https://<HOST>:<PORT>/v1/actions/34", "perms":[ "delete", "read", "write", "administration" ], "name":"Execute on UCSD", "description":"", "actionType":"INVOKE_UCSD_WORKFLOW", "lastUpdatedTime":"2017-05-12 21:00:25.005", "timeOut":1200, "enabled":true, "encrypted":true, "deleted":false, "systemDefined":false, "bulkOperationSupported":true, "isAvailableToUser":true, "owner":2, "actionParameters":[ { "paramName":"ucsdServer", "paramValue":"192.168.30.222", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"workflowName", "paramValue":"CreateSnapShot", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"apiKey", "paramValue":"XRbvgIyhdEkfeX0XYJtt+Ucp1jS+hFspfKfNwuRlkNwubLEG8TBpmcJnpvMo65cd", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" } ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ "all" ], "cloudRegions":[ "all" ], "cloudAccounts":[ "all" ], "services":[ "all" ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ ] }, "isEditable":true }, { "deploymentResource":null, "vmResource":{ "type":"IMPORTED_VM", "appProfiles":[ ], "cloudRegions":[ "all" ], "cloudAccounts":[ "all" ], "services":[ ], "osTypes":[ "all" ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"36", "resource":"https://<HOST>:<PORT>/v1/actions/36", "perms":[ "delete", "read", "write", "administration" ], "name":"CreateDocDemoWebService", "description":"", "actionType":"INVOKE_WEB_SERVICE", "lastUpdatedTime":"2017-05-19 18:11:11.957", "timeOut":1200, "enabled":true, "encrypted":true, "deleted":false, "systemDefined":false, "bulkOperationSupported":true, "isAvailableToUser":true, "owner":2, "actionParameters":[ { "paramName":"wsRequestType", "paramValue":"post", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsUsername", "paramValue":"admin@cliqrtech.com", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsUrl", "paramValue":"www.docs.cloudcenter.cisco.com/", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsProtocol", "paramValue":"http", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsCommandParams", "paramValue":"", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsPassword", "paramValue":"OHsc+XzCTi3adV8MBPFWxA==", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsContentType", "paramValue":"json", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsBody", "paramValue":"", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" } ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ "all" ], "cloudRegions":[ "all" ], "cloudAccounts":[ "all" ], "services":[ "all" ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"37", "resource":"https://<HOST>:<PORT>/v1/actions/37", "perms":[ "delete", "read", "write", "administration" ], "name":"DockDemoIWSdep", "description":"", "actionType":"INVOKE_WEB_SERVICE", "lastUpdatedTime":"2017-05-19 18:17:35.362", "timeOut":1200, "enabled":true, "encrypted":true, "deleted":false, "systemDefined":false, "bulkOperationSupported":true, "isAvailableToUser":true, "owner":2, "actionParameters":[ { "paramName":"wsRequestType", "paramValue":"post", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsUsername", "paramValue":"admin@cliqrtech.com", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsUrl", "paramValue":"www.docs.cloudcenter.cisco.com", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsProtocol", "paramValue":"http", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsCommandParams", "paramValue":"", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsPassword", "paramValue":"OHsc+XzCTi3adV8MBPFWxA==", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsContentType", "paramValue":"json", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsBody", "paramValue":"", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" } ], "actionResourceMappings":[ { "type":"DEPLOYMENT", "actionResourceFilters":[ { "deploymentResource":{ "deploymentEnvironments":[ "all" ], "services":[ "all" ] }, "vmResource":null, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"38", "resource":"https://<HOST>:<PORT>/v1/actions/38", "perms":[ "delete", "read", "write", "administration" ], "name":"test111", "description":"", "actionType":"EXECUTE_COMMAND", "lastUpdatedTime":"2017-05-24 00:07:38.219", "timeOut":1200, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":false, "bulkOperationSupported":true, "isAvailableToUser":true, "owner":2, "actionParameters":[ { "paramName":"downloadFromBundle", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"script", "paramValue":"test", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"executeOnContainer", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"rebootInstance", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"refreshInstanceInfo", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" } ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ "all" ], "cloudRegions":[ "all" ], "cloudAccounts":[ "all" ], "services":[ "all" ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] } ] }
Example 2
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/actions/15"
Response
{ "id":"15", "resource":"https://<HOST>:<PORT>/v1/actions/15", "perms":[ "delete", "read", "write", "administration" ], "name":"Test", "description":"", "actionType":"EXECUTE_COMMAND", "lastUpdatedTime":"2017-05-01 23:24:51.173", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":false, "bulkOperationSupported":true, "isAvailableToUser":true, "owner":2, "actionParameters":[ { "paramName":"downloadFromBundle", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"script", "paramValue":"hkjhkgkjhk", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"executeOnContainer", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"rebootInstance", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"refreshInstanceInfo", "paramValue":"false", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" } ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ "all" ], "cloudRegions":[ "all" ], "cloudAccounts":[ "all" ], "services":[ "all" ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ { "key":"repositories", "nvpairTypes":[ ] } ], "actionCustomParamSpecs":[ { "paramName":"hostname123", "displayName":"hostname123", "helpText":"", "type":"string", "valueList":null, "defaultValue":"", "confirmValue":null, "pathSuffixValue":"", "userVisible":true, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":false, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":"", "protocol":"", "username":"", "password":"", "requestType":null, "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"VISIBLE_UNLOCKED" }, { "paramName":"hostname1234", "displayName":"hostname", "helpText":"", "type":"string", "valueList":null, "defaultValue":"kjhkjhk", "confirmValue":null, "pathSuffixValue":"", "userVisible":true, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":true, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":"", "protocol":"", "username":"", "password":"", "requestType":null, "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"VISIBLE_UNLOCKED" } ] }
Example 3 – includeSystemDefinedActions=true
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/actions?includeSystemDefinedActions=true"
The response to this API includes an ID as well as the actionType. Specify the actionType in the URL to view a single response. For example, to view the details of an import action, issue the following request:
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/actions?includeSystemDefinedActions=true&actionType=IMPORT_VM"
Response
{ "resource":null, "size":14, "pageNumber":0, "totalElements":14, "totalPages":1, "actionJaxbs":[ { "id":"13", "resource":"https://<HOST>:<PORT>/v1/actions/13", "name":"Install CloudCenter Agent", "description":"pushes agent lite on brownfield virtual machines", "actionType":"PUSH_AGENT", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"IMPORTED_VM", "appProfiles":[ ], "cloudRegions":[ "all" ], "cloudAccounts":[ "all" ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"all", "nodeStates":[ "NodeStarted", "NodeReady" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ { "paramName":"osType", "displayName":"Os Type", "helpText":null, "type":"radio", "valueList":"[{\"title\":\"Linux\",\"key\":\"linux\"},{\"title\" : \"Windows\",\"key\" : \"Windows\"}]", "defaultValue":"linux", "confirmValue":null, "pathSuffixValue":"", "userVisible":true, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":false, "deploymentParam":false, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":null, "protocol":null, "username":null, "password":null, "requestType":null, "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"VISIBLE_UNLOCKED" }, { "paramName":"domain", "displayName":"Domain", "helpText":null, "type":"string", "valueList":null, "defaultValue":"", "confirmValue":null, "pathSuffixValue":"", "userVisible":true, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":true, "deploymentParam":false, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":null, "protocol":null, "username":null, "password":null, "requestType":null, "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"VISIBLE_UNLOCKED" }, { "paramName":"authType", "displayName":"Authentication Type", "helpText":null, "type":"radio", "valueList":"[{\"title\":\"SSH Key\",\"key\":\"ssh_key\"},{\"title\" : \"Password\",\"key\" : \"password\"}]", "defaultValue":"ssh_key", "confirmValue":null, "pathSuffixValue":"", "userVisible":true, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":false, "deploymentParam":false, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":null, "protocol":null, "username":null, "password":null, "requestType":null, "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"VISIBLE_UNLOCKED" }, { "paramName":"user", "displayName":"User", "helpText":"virtual machine user", "type":"string", "valueList":null, "defaultValue":"root", "confirmValue":null, "pathSuffixValue":"", "userVisible":true, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":false, "deploymentParam":false, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":null, "protocol":null, "username":null, "password":null, "requestType":null, "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"VISIBLE_UNLOCKED" }, { "paramName":"password", "displayName":"Password", "helpText":null, "type":"string", "valueList":null, "defaultValue":"", "confirmValue":null, "pathSuffixValue":"", "userVisible":true, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":true, "deploymentParam":false, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":null, "protocol":null, "username":null, "password":null, "requestType":null, "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"VISIBLE_UNLOCKED" }, { "paramName":"ssh_key", "displayName":"SSH Key", "helpText":"key to login to the node", "type":"string", "valueList":null, "defaultValue":"", "confirmValue":null, "pathSuffixValue":"", "userVisible":true, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":true, "deploymentParam":false, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":null, "protocol":null, "username":null, "password":null, "requestType":null, "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"VISIBLE_UNLOCKED" }, { "paramName":"executeOnContainer", "displayName":"executeOnContainer", "helpText":null, "type":"string", "valueList":null, "defaultValue":"true", "confirmValue":null, "pathSuffixValue":"", "userVisible":false, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":false, "deploymentParam":false, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":null, "protocol":null, "username":null, "password":null, "requestType":null, "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"NOT_VISIBLE_LOCKED" } ] }, { "id":"6", "resource":"https://<HOST>:<PORT>/v1/actions/6", "name":"Detach Volume", "description":"detach volume", "actionType":"INSTANCE_DETACH_VOLUME", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":false, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"Amazon", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] }, { "cloudFamily":"Openstack", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] }, { "cloudFamily":"Vmware", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] }, { "cloudFamily":"Google", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] }, { "cloudFamily":"Vcd", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"2", "resource":"https://<HOST>:<PORT>/v1/actions/2", "name":"Start", "description":"start the instance", "actionType":"INSTANCE_START", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"all", "nodeStates":[ "NodeSuspended" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"1", "resource":"https://<HOST>:<PORT>/v1/actions/1", "name":"Stop", "description":"stop the instance", "actionType":"INSTANCE_STOP", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"all", "nodeStates":[ "NodeReady", "NodeStarted" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"12", "resource":"https://<HOST>:<PORT>/v1/actions/12", "perms":[ "write", "administration", "read", "delete" ], "name":"EchoHelloWorld", "description":"Echoes hello world", "actionType":"EXECUTE_COMMAND", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":false, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":2, "actionParameters":[ { "paramName":"downloadFromBundle", "paramValue":"false", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"script", "paramValue":"echo \"hello world\"", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"executeOnContainer", "paramValue":"", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"rebootInstance", "paramValue":"", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"refreshInstanceInfo", "paramValue":"", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" } ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"IMPORTED_VM", "appProfiles":[ ], "cloudRegions":[ "2" ], "cloudAccounts":[ "2" ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"16", "resource":"https://<HOST>:<PORT>/v1/actions/16", "perms":[ "write", "administration", "read", "delete" ], "name":"TestWebservice", "description":"", "actionType":"INVOKE_WEB_SERVICE", "lastUpdatedTime":"2017-04-20 01:27:08.756", "timeOut":1200, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":false, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":2, "actionParameters":[ { "paramName":"wsRequestType", "paramValue":"get", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsUsername", "paramValue":"", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsUrl", "paramValue":"<HOST>:<PORT>/v1/tenants/1/services", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsProtocol", "paramValue":"http", "customParam":false, "required":true, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsCommandParams", "paramValue":"", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsPassword", "paramValue":"", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsContentType", "paramValue":"json", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" }, { "paramName":"wsBody", "paramValue":"", "customParam":false, "required":false, "preference":"NOT_VISIBLE_LOCKED" } ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"IMPORTED_VM", "appProfiles":[ ], "cloudRegions":[ "all" ], "cloudAccounts":[ "all" ], "services":[ ], "osTypes":[ "all" ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ { "paramName":"size", "displayName":"total records", "helpText":"", "type":"webservice", "valueList":null, "defaultValue":"", "confirmValue":null, "pathSuffixValue":"", "userVisible":true, "userEditable":true, "systemParam":false, "exampleValue":null, "dataUnit":null, "optional":false, "deploymentParam":false, "multiselectSupported":false, "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255, "regex":null, "allowSpaces":true, "sizeValue":0, "step":0, "calloutWorkflowName":null }, "scope":null, "webserviceListParams":{ "url":"services.groupkt.com/country/get/all", "protocol":"http", "username":"", "password":"", "requestType":"GET", "contentType":null, "commandParams":null, "requestBody":null, "resultString":null }, "collectionList":[ ], "preference":"VISIBLE_UNLOCKED" } ] }, { "id":"3", "resource":"https://<HOST>:<PORT>/v1/actions/3", "name":"Reboot", "description":"reboot the instance", "actionType":"INSTANCE_REBOOT", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"all", "nodeStates":[ "NodeReady", "NodeStarted", "NodeNotReachable" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"4", "resource":"https://<HOST>:<PORT>/v1/actions/4", "name":"Terminate", "description":"terminate the instance", "actionType":"INSTANCE_TERMINATE", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"all", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended", "NodeError", "NodeNotReachable", "NodeNotFound" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"5", "resource":"https://<HOST>:<PORT>/v1/actions/5", "name":"Create And Attach Volume", "description":"create and attach volume", "actionType":"INSTANCE_CREATE_ATTACH_VOLUME", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":false, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"Amazon", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] }, { "cloudFamily":"Openstack", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] }, { "cloudFamily":"Vmware", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] }, { "cloudFamily":"Google", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] }, { "cloudFamily":"Vcd", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"7", "resource":"https://<HOST>:<PORT>/v1/actions/7", "name":"Create Snapshot", "description":"create snapshot", "actionType":"INSTANCE_CREATE_SNAPSHOT", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":false, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"Vmware", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"8", "resource":"https://<HOST>:<PORT>/v1/actions/8", "name":"Import to CloudCenter", "description":"import brownfield vms", "actionType":"IMPORT_VM", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"11", "resource":"https://<HOST>:<PORT>/v1/actions/11", "name":"Upgrade CloudCenter Agent", "description":"upgrade to latest agent", "actionType":"UPGRADE_AGENT", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"all", "nodeStates":[ "NodeReady", "NodeStarted" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"9", "resource":"https://<HOST>:<PORT>/v1/actions/9", "name":"Resize Instance Type", "description":"reconfig instance", "actionType":"INSTANCE_RECONFIG", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":false, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"Amazon", "nodeStates":[ "NodeSuspended" ] }, { "cloudFamily":"Openstack", "nodeStates":[ "NodeReady", "NodeStarted", "NodeSuspended" ] }, { "cloudFamily":"Vmware", "nodeStates":[ "NodeSuspended" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }, { "id":"14", "resource":"https://<HOST>:<PORT>/v1/actions/14", "name":"Sync VM Information", "description":"Sync VM Information from the Cloud", "actionType":"REFRESH_VM", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":true, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"Amazon", "nodeStates":[ "NodeStarting", "NodeStarted", "NodeReady", "NodeCleaned", "NodeError", "NodeNotReachable", "NodeReachable", "NodeSuspended", "NodeSuspending", "NodeResuming", "NodeResumed", "NodeRebooted" ] }, { "cloudFamily":"Openstack", "nodeStates":[ "NodeStarting", "NodeStarted", "NodeReady", "NodeCleaned", "NodeError", "NodeNotReachable", "NodeReachable", "NodeSuspended", "NodeSuspending", "NodeResuming", "NodeResumed", "NodeRebooted" ] }, { "cloudFamily":"Vmware", "nodeStates":[ "NodeStarting", "NodeStarted", "NodeReady", "NodeCleaned", "NodeError", "NodeNotReachable", "NodeReachable", "NodeSuspended", "NodeSuspending", "NodeResuming", "NodeResumed", "NodeRebooted" ] }, { "cloudFamily":"Azure", "nodeStates":[ "NodeStarting", "NodeStarted", "NodeReady", "NodeCleaned", "NodeError", "NodeNotReachable", "NodeReachable", "NodeSuspended", "NodeSuspending", "NodeResuming", "NodeResumed", "NodeRebooted" ] }, { "cloudFamily":"AzureRM", "nodeStates":[ "NodeStarting", "NodeStarted", "NodeReady", "NodeCleaned", "NodeError", "NodeNotReachable", "NodeReachable", "NodeSuspended", "NodeSuspending", "NodeResuming", "NodeResumed", "NodeRebooted" ] }, { "cloudFamily":"AzurePack", "nodeStates":[ "NodeStarting", "NodeStarted", "NodeReady", "NodeCleaned", "NodeError", "NodeNotReachable", "NodeReachable", "NodeSuspended", "NodeSuspending", "NodeResuming", "NodeResumed", "NodeRebooted" ] }, { "cloudFamily":"Vcd", "nodeStates":[ "NodeStarting", "NodeStarted", "NodeReady", "NodeCleaned", "NodeError", "NodeNotReachable", "NodeReachable", "NodeSuspended", "NodeSuspending", "NodeResuming", "NodeResumed", "NodeRebooted" ] }, { "cloudFamily":"Google", "nodeStates":[ "NodeStarting", "NodeStarted", "NodeReady", "NodeCleaned", "NodeError", "NodeNotReachable", "NodeReachable", "NodeSuspended", "NodeSuspending", "NodeResuming", "NodeResumed", "NodeRebooted" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] } ] }
Example 4 – Custom Actions
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/actions"
By default, if you do not pass the includeSystemDefinedActions query attribute, this API returns only custom-defined actions only which are accessible/visible to current user.
Response
{ "name":"Sleep", "description":"", "timeOut":1200, "actionType":"EXECUTE_COMMAND", "actionParameters":[ { "paramName":"downloadFromBundle", "paramValue":false, "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"script", "paramValue":"sleep $time", "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"executeOnContainer", "paramValue":false, "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"rebootInstance", "paramValue":false, "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" }, { "paramName":"refreshInstanceInfo", "paramValue":false, "customParam":false, "required":true, "preference":"VISIBLE_UNLOCKED" } ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "services":[ ], "cloudRegions":[ ], "cloudAccounts":[ ] } } ] } ], "actionCustomParamSpecs":[ { "paramName":"time", "displayName":"time for sleep", "helpText":"Sleep time", "type":"number", "valueList":null, "defaultValue":"10", "confirmValue":"", "userVisible":true, "userEditable":true, "optional":false, "preference":"VISIBLE_UNLOCKED", "valueConstraint":{ "minValue":0, "maxValue":255, "maxLength":255 }, "webserviceListParams":{ "url":"", "protocol":"http", "username":"", "password":"" } } ] }
Example 5 – ServiceNow Approval Flow Actions
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/actions/14"
Response – CANCEL_APPROVAL_REQUEST
{ "id":"14", "resource":"https://<HOST>:<PORT>/v1/actions/14", "name":"Cancel Approval Request", "description":"cancel approval request", "actionType":"CANCEL_APPROVAL_REQUEST", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":false, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[], "cloudRegions":[], "cloudAccounts":[], "services":[], "osTypes":[], "cloudFamilyNames":[], "nodeStates":[], "cloudResourceMappings":[ { "cloudFamily":"all", "nodeStates":[ "all" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[] }
Response – RESEND_APPROVAL_REQUEST
{ "id":"13", "resource":"https://10.0.0.242/v1/actions/13", "name":"Resend Approval Request", "description":"resend approval request", "actionType":"RESEND_APPROVAL_REQUEST", "lastUpdatedTime":"", "timeOut":600, "enabled":true, "encrypted":false, "deleted":false, "systemDefined":true, "bulkOperationSupported":false, "isAvailableToUser":true, "currentlyExecuting":false, "owner":1, "actionParameters":[ ], "actionResourceMappings":[ { "type":"VIRTUAL_MACHINE", "actionResourceFilters":[ { "deploymentResource":null, "vmResource":{ "type":"DEPLOYMENT_VM", "appProfiles":[ ], "cloudRegions":[ ], "cloudAccounts":[ ], "services":[ ], "osTypes":[ ], "cloudFamilyNames":[ ], "nodeStates":[ ], "cloudResourceMappings":[ { "cloudFamily":"all", "nodeStates":[ "all" ] } ] }, "isEditable":true } ] } ], "actionResourceMappingAncillaries":[ ], "actionCustomParamSpecs":[ ] }
Example 6 – All actions for LIFECYCLE Category
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/actions/?category=LIFECYCLE"
Response
[ { "resourceId": "35", "actions": [ { "id": "56", "resource": "https://172.16.70.22/v1/actions/56", "name": "a6", "description": "", "actionType": "EXECUTE_COMMAND", "category": "LIFECYCLE", "lastUpdatedTime": "2018-02-13 06:57:49.413", "timeOut": 1200, "enabled": true, "encrypted": false, "deleted": false, "systemDefined": false, "bulkOperationSupported": true, "isAvailableToUser": true, "currentlyExecuting": false, "owner": 2, "actionParameters": [ { "paramName": "wsRequestType", "paramValue": "get", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "wsBody", "paramValue": "", "customParam": false, "required": false, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "executeOnContainer", "paramValue": "false", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "script", "paramValue": "ls", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "downloadFromBundle", "paramValue": "false", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" } ], "actionResourceMappings": [ { "type": "APPLICATION_PROFILE", "actionResourceFilters": [ { "cloudRegionResource": null, "serviceResource": null, "applicationProfileResource": { "applicationProfiles": [ "29", "35" ] }, "deploymentResource": null, "vmResource": null, "isEditable": true } ] } ], "actionResourceMappingAncillaries": [], "actionCustomParamSpecs": [] } ] }, { "resourceId": "29", "actions": [ { "id": "55", "resource": "https://172.16.70.22/v1/actions/55", "name": "a5", "description": "", "actionType": "EXECUTE_COMMAND", "category": "LIFECYCLE", "lastUpdatedTime": "2018-02-13 06:56:31.893", "timeOut": 1200, "enabled": true, "encrypted": false, "deleted": false, "systemDefined": false, "bulkOperationSupported": true, "isAvailableToUser": true, "currentlyExecuting": false, "owner": 2, "actionParameters": [ { "paramName": "wsRequestType", "paramValue": "get", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "wsBody", "paramValue": "", "customParam": false, "required": false, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "executeOnContainer", "paramValue": "false", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "script", "paramValue": "ls", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "downloadFromBundle", "paramValue": "false", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" } ], "actionResourceMappings": [ { "type": "APPLICATION_PROFILE", "actionResourceFilters": [ { "cloudRegionResource": null, "serviceResource": null, "applicationProfileResource": { "applicationProfiles": [ "29" ] }, "deploymentResource": null, "vmResource": null, "isEditable": true } ] } ], "actionResourceMappingAncillaries": [], "actionCustomParamSpecs": [] }, { "id": "56", "resource": "https://172.16.70.22/v1/actions/56", "name": "a6", "description": "", "actionType": "EXECUTE_COMMAND", "category": "LIFECYCLE", "lastUpdatedTime": "2018-02-13 06:57:49.413", "timeOut": 1200, "enabled": true, "encrypted": false, "deleted": false, "systemDefined": false, "bulkOperationSupported": true, "isAvailableToUser": true, "currentlyExecuting": false, "owner": 2, "actionParameters": [ { "paramName": "wsRequestType", "paramValue": "get", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "wsBody", "paramValue": "", "customParam": false, "required": false, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "executeOnContainer", "paramValue": "false", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "script", "paramValue": "ls", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" }, { "paramName": "downloadFromBundle", "paramValue": "false", "customParam": false, "required": true, "preference": "NOT_VISIBLE_LOCKED" } ], "actionResourceMappings": [ { "type": "APPLICATION_PROFILE", "actionResourceFilters": [ { "cloudRegionResource": null, "serviceResource": null, "applicationProfileResource": { "applicationProfiles": [ "29", "35" ] }, "deploymentResource": null, "vmResource": null, "isEditable": true } ] } ], "actionResourceMappingAncillaries": [], "actionCustomParamSpecs": [] } ] } ]
Request Attributes
actionId
| ||||||
Optional query parameter includeSystemDefinedActions
| ||||||
category
|
Response Attributes
id
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
perms
perms
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
actionType
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastUpdatedTime
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
timeout
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enabled
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
encrypted This description and type differs for a request and a response:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deleted
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
systemDefined
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bulkOperationSupported
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAvailableToUser
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
owner
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
actionParameters
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
actionResourceMappings
actionResourceMappings
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
actionCustomParamSpecs
actionCustomParamSpecs
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
actionResourceMappingAncillaries
|
- No labels