PUT zstack/v1/platform-services/packages/actions

Authorization: OAuth the-session-uuid

{
  "uploadPlatformServicePackage": {
    "name": "zlr-package",
    "serviceType": "ZLR",
    "artifactType": "Qcow2",
    "url": "file:///data/zlr-zrm-1.0.0.qcow2",
    "backupStorageUuid": "ff081de062bd338eb907962028e64d00"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X PUT -d '{"uploadPlatformServicePackage":{"name":"zlr-package","serviceType":"ZLR","artifactType":"Qcow2","url":"file:///data/zlr-zrm-1.0.0.qcow2","backupStorageUuid":"ff081de062bd338eb907962028e64d00"}}' http://localhost:8080/zstack/v1/platform-services/packages/actions

{
  "inventory": {
    "uuid": "80387501189d4d6795ab710e32e8d835",
    "name": "zlr-package",
    "serviceType": "ZLR",
    "artifactType": "Qcow2",
    "imageUuid": "5719e30fc3474c3996318b9e6f36cd80",
    "status": "Uploaded",
    "operationState": "Succeeded",
    "progress": 100,
    "uploadFileUrl": "http://127.0.0.1:8001/imagestore/file/direct/upload",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM"
  }
}

UploadPlatformServicePackageAction action = new UploadPlatformServicePackageAction();
action.name = "zlr-package";
action.serviceType = "ZLR";
action.artifactType = "Qcow2";
action.url = "file:///data/zlr-zrm-1.0.0.qcow2";
action.backupStorageUuid = "ff081de062bd338eb907962028e64d00";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UploadPlatformServicePackageAction.Result res = action.call();

action = UploadPlatformServicePackageAction()
action.name = "zlr-package"
action.serviceType = "ZLR"
action.artifactType = "Qcow2"
action.url = "file:///data/zlr-zrm-1.0.0.qcow2"
action.backupStorageUuid = "ff081de062bd338eb907962028e64d00"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/platform-services/packages
GET zstack/v1/platform-services/packages/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/platform-services/packages?q=uuid=ff062ec74ff33684b183abeeb7031e00

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/platform-services/packages/373d7c072ed732b091d951fed4c2afeb

{
  "inventories": [
    {
      "uuid": "3b1c86aeeab24b1e954feb200b99c375",
      "name": "zlr-package",
      "serviceType": "ZLR",
      "artifactType": "Qcow2",
      "imageUuid": "712e59d33eec4d20a1f319da2ebd38d2",
      "status": "Uploaded",
      "operationState": "Succeeded",
      "progress": 100,
      "uploadFileUrl": "http://127.0.0.1:8001/imagestore/file/direct/upload",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    }
  ]
}

QueryPlatformServicePackageAction action = new QueryPlatformServicePackageAction();
action.conditions = asList("uuid=ff062ec74ff33684b183abeeb7031e00");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryPlatformServicePackageAction.Result res = action.call();

action = QueryPlatformServicePackageAction()
action.conditions = ["uuid=ff062ec74ff33684b183abeeb7031e00"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

PUT zstack/v1/platform-services/packages/{packageUuid}/actions

Authorization: OAuth the-session-uuid

{
  "deployPlatformService": {
    "name": "zlr",
    "cpuNum": 2,
    "memorySize": 4294967296,
    "l3NetworkUuids": [
      "ff0defdc65883886b5a760acc322c300"
    ],
    "staticIp": "192.168.0.10",
    "netmask": "255.255.255.0",
    "gateway": "192.168.0.1",
    "language": "zh_CN",
    "mnUsername": "admin"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X PUT -d '{"deployPlatformService":{"name":"zlr","cpuNum":2,"memorySize":4294967296,"l3NetworkUuids":["ff0defdc65883886b5a760acc322c300"],"staticIp":"192.168.0.10","netmask":"255.255.255.0","gateway":"192.168.0.1","language":"zh_CN","mnUsername":"admin"}}' http://localhost:8080/zstack/v1/platform-services/packages/ff062ec74ff33684b183abeeb7031e00/actions

{
  "inventory": {
    "uuid": "fb2a0d1272394227b101a5d72bc7b134",
    "name": "zlr",
    "serviceType": "ZLR",
    "packageUuid": "0e61188c58014bd28ad1382959fcbdd7",
    "vmInstanceUuid": "f97d64a8e797432d9f954f1de641f618",
    "state": "Deployed",
    "healthStatus": "Healthy",
    "version": "1.0.0",
    "operationState": "Succeeded",
    "progress": 100,
    "lastHealthCheckTime": "Nov 14, 2017 2:20:57 PM",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM"
  }
}

DeployPlatformServiceAction action = new DeployPlatformServiceAction();
action.packageUuid = "ff062ec74ff33684b183abeeb7031e00";
action.name = "zlr";
action.cpuNum = 2;
action.memorySize = 4294967296;
action.l3NetworkUuids = asList("ff0defdc65883886b5a760acc322c300");
action.staticIp = "192.168.0.10";
action.netmask = "255.255.255.0";
action.gateway = "192.168.0.1";
action.language = "zh_CN";
action.mnUsername = "admin";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeployPlatformServiceAction.Result res = action.call();

action = DeployPlatformServiceAction()
action.packageUuid = "ff062ec74ff33684b183abeeb7031e00"
action.name = "zlr"
action.cpuNum = 2
action.memorySize = 4294967296
action.l3NetworkUuids = [ff0defdc65883886b5a760acc322c300]
action.staticIp = "192.168.0.10"
action.netmask = "255.255.255.0"
action.gateway = "192.168.0.1"
action.language = "zh_CN"
action.mnUsername = "admin"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/platform-services/instances

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/platform-services/instances?serviceType=ZLR

{
  "inventories": [
    {
      "uuid": "2ea3e337833942678c063a8fdc85de6d",
      "name": "zlr",
      "serviceType": "ZLR",
      "packageUuid": "a28a14344a604c39b337800bf6e86e1c",
      "vmInstanceUuid": "aae71df9e224410fbf43aada6f21c961",
      "state": "Deployed",
      "healthStatus": "Healthy",
      "version": "1.0.0",
      "operationState": "Succeeded",
      "progress": 100,
      "lastHealthCheckTime": "Nov 14, 2017 2:20:57 PM",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    }
  ]
}

GetPlatformServiceInstancesAction action = new GetPlatformServiceInstancesAction();
action.serviceType = "ZLR";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetPlatformServiceInstancesAction.Result res = action.call();

action = GetPlatformServiceInstancesAction()
action.serviceType = "ZLR"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/platform-services/instances/{uuid}/vm-instances

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/platform-services/instances/ff0e6f5e01e23b1fbd616d28a9280400/vm-instances?

{
  "inventories": [
    {}
  ]
}

GetPlatformServiceVmInstancesAction action = new GetPlatformServiceVmInstancesAction();
action.uuid = "ff0e6f5e01e23b1fbd616d28a9280400";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetPlatformServiceVmInstancesAction.Result res = action.call();

action = GetPlatformServiceVmInstancesAction()
action.uuid = "ff0e6f5e01e23b1fbd616d28a9280400"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

PUT zstack/v1/platform-services/instances/{uuid}/actions

Authorization: OAuth the-session-uuid

{
  "checkPlatformServiceHealth": {},
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X PUT -d '{"checkPlatformServiceHealth":{}}' http://localhost:8080/zstack/v1/platform-services/instances/ff0e6f5e01e23b1fbd616d28a9280400/actions

{
  "inventory": {
    "uuid": "a20c329f4373444b81801bae4da83550",
    "name": "zlr",
    "serviceType": "ZLR",
    "packageUuid": "f81e3a5c1d5240658564b6c25a7d6e8b",
    "vmInstanceUuid": "e884993195df45d4a8514296098ccc7f",
    "state": "Deployed",
    "healthStatus": "Healthy",
    "version": "1.0.0",
    "operationState": "Succeeded",
    "progress": 100,
    "lastHealthCheckTime": "Nov 14, 2017 2:20:57 PM",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM"
  }
}

CheckPlatformServiceHealthAction action = new CheckPlatformServiceHealthAction();
action.uuid = "ff0e6f5e01e23b1fbd616d28a9280400";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CheckPlatformServiceHealthAction.Result res = action.call();

action = CheckPlatformServiceHealthAction()
action.uuid = "ff0e6f5e01e23b1fbd616d28a9280400"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

PUT zstack/v1/platform-services/instances/{uuid}/actions

Authorization: OAuth the-session-uuid

{
  "undeployPlatformService": {},
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X PUT -d '{"undeployPlatformService":{}}' http://localhost:8080/zstack/v1/platform-services/instances/ff0e6f5e01e23b1fbd616d28a9280400/actions

{
  "inventory": {
    "uuid": "9492259135a04927b5bf93de67695ef8",
    "name": "zlr",
    "serviceType": "ZLR",
    "packageUuid": "4a4622a797f04fe79e73c7274d45e0c1",
    "vmInstanceUuid": "16d489e3993545848c95cb9770301943",
    "state": "Deployed",
    "healthStatus": "Healthy",
    "version": "1.0.0",
    "operationState": "Succeeded",
    "progress": 100,
    "lastHealthCheckTime": "Nov 14, 2017 2:20:57 PM",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM"
  }
}

UndeployPlatformServiceAction action = new UndeployPlatformServiceAction();
action.uuid = "ff0e6f5e01e23b1fbd616d28a9280400";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UndeployPlatformServiceAction.Result res = action.call();

action = UndeployPlatformServiceAction()
action.uuid = "ff0e6f5e01e23b1fbd616d28a9280400"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

DELETE zstack/v1/platform-services/packages/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X DELETE http://localhost:8080/zstack/v1/platform-services/packages/ff062ec74ff33684b183abeeb7031e00?deleteMode=Permissive

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

DeletePlatformServicePackageAction action = new DeletePlatformServicePackageAction();
action.uuid = "ff062ec74ff33684b183abeeb7031e00";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeletePlatformServicePackageAction.Result res = action.call();

action = DeletePlatformServicePackageAction()
action.uuid = "ff062ec74ff33684b183abeeb7031e00"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

POST zstack/v1/external/service/configurations

Authorization: OAuth the-session-uuid

{
  "params": {
    "externalServiceType": "Prometheus2",
    "configuration": "{}",
    "description": "description"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X POST -d '{"params":{"externalServiceType":"Prometheus2","configuration":"{}","description":"description"}}' http://localhost:8080/zstack/v1/external/service/configurations

{
  "inventory": {
    "uuid": "66004d1914e733fd8236e0916f43d860",
    "serviceType": "Prometheus2",
    "configuration": "{}"
  }
}

AddExternalServiceConfigurationAction action = new AddExternalServiceConfigurationAction();
action.externalServiceType = "Prometheus2";
action.configuration = "{}";
action.description = "description";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddExternalServiceConfigurationAction.Result res = action.call();

action = AddExternalServiceConfigurationAction()
action.externalServiceType = "Prometheus2"
action.configuration = "{}"
action.description = "description"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

DELETE zstack/v1/external/service/configurations/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X DELETE http://localhost:8080/zstack/v1/external/service/configurations/aa1a4fca6262310aa6b780018ba346df?deleteMode=Permissive

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

DeleteExternalServiceConfigurationAction action = new DeleteExternalServiceConfigurationAction();
action.uuid = "aa1a4fca6262310aa6b780018ba346df";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteExternalServiceConfigurationAction.Result res = action.call();

action = DeleteExternalServiceConfigurationAction()
action.uuid = "aa1a4fca6262310aa6b780018ba346df"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/external/service/configurations
GET zstack/v1/external/service/configurations/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/external/service/configurations?q=uuid=efca0d027c943d91bbf524e297a17029

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/external/service/configurations/c8effcfb93a43e138e12b67881cb487f

{
  "inventories": [
    {
      "uuid": "249687cb3ea3309f9f0eafde752ea08b",
      "serviceType": "Prometheus2",
      "configuration": "{}"
    }
  ]
}

QueryExternalServiceConfigurationAction action = new QueryExternalServiceConfigurationAction();
action.conditions = asList("uuid=a975960c59c83af38c48aad79b966b4e");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryExternalServiceConfigurationAction.Result res = action.call();

action = QueryExternalServiceConfigurationAction()
action.conditions = ["uuid=10ffe79c134332b585c2af7eb5a22847"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

PUT zstack/v1/external/service/configurations/{uuid}

Authorization: OAuth the-session-uuid

{
  "updateExternalServiceConfiguration": {
    "description": "description",
    "configuration": "{}"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X PUT -d '{"updateExternalServiceConfiguration":{"description":"description","configuration":"{}"}}' http://localhost:8080/zstack/v1/external/service/configurations/9a3118bffd913ea68caa76b9a668837d

{
  "inventory": {
    "uuid": "da66ea66a447381db5295a14a5c62b2b"
  }
}

UpdateExternalServiceConfigurationAction action = new UpdateExternalServiceConfigurationAction();
action.uuid = "9a3118bffd913ea68caa76b9a668837d";
action.description = "description";
action.configuration = "{}";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateExternalServiceConfigurationAction.Result res = action.call();

action = UpdateExternalServiceConfigurationAction()
action.uuid = "9a3118bffd913ea68caa76b9a668837d"
action.description = "description"
action.configuration = "{}"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()