DeleteVmSshKey
API Request
URLs
DELETE zstack/v1/vm-instances/{uuid}/ssh-keysHeaders
Authorization: OAuth the-session-uuidCurl
Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth: 2698b6ec6f4241e696c75416e8e31b48" \
-X DELETE http://localhost:8080/zstack/v1/vm-instances/add84c70ff0f4c98b897d6a3d7ba475c/ssh-keysRequest Parameters
| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | Optional. The VM instance UUID. | 0.6 | |
| systemTags | List | body | Optional. The system tags. | 0.6 | |
| userTags | List | body | Optional. The user tags. | 0.6 |
API Response
Sample
Response
{
"inventory": {
"uuid": "1ea667c144cf431e9b1a9ca503947735",
"name": "Test-VM",
"description": "web server VM",
"zoneUuid": "8de2e6726a4d412d9a8a445c5a85cfe4",
"clusterUuid": "51900cf42e62496e90f61a9553f2dd44",
"imageUuid": "309fa4ff1c1244dab6a350260e7c5838",
"hostUuid": "64eeb6a53f534903b645f881e143140c",
"lastHostUuid": "f11e3f8134a9473e8754580ab24e425e",
"instanceOfferingUuid": "701ec48f6e084db4801ef0029cd8cee5",
"rootVolumeUuid": "627b25aebb5143a9a98bb3cab47341cf",
"platform": "Linux",
"defaultL3NetworkUuid": "056f3dc6e1ec4a71b5bff6f0db3cc749",
"type": "UserVm",
"hypervisorType": "KVM",
"memorySize": 8.589934592E9,
"cpuNum": 1.0,
"allocatorStrategy": "LastHostPreferredAllocatorStrategy",
"createDate": "Apr 24, 2017 7:11:29 PM",
"lastOpDate": "Apr 24, 2017 7:11:29 PM",
"state": "Stopped",
"vmNics": [
{
"uuid": "33f03792d00c471e94b4cc42457a7e2a",
"vmInstanceUuid": "1ea667c144cf431e9b1a9ca503947735",
"usedIpUuid": "0dc93b05d54643b699a02427688a0871",
"l3NetworkUuid": "056f3dc6e1ec4a71b5bff6f0db3cc749",
"ip": "192.168.1.10",
"mac": "00:0c:29:bd:99:fc",
"netmask": "255.255.255.0",
"gateway": "192.168.1.1",
"deviceId": 0.0,
"createDate": "Apr 24, 2017 7:11:29 PM",
"lastOpDate": "Apr 24, 2017 7:11:29 PM"
}
],
"allVolumes": [
{
"uuid": "627b25aebb5143a9a98bb3cab47341cf",
"name": "Root-Volume-For-VM-1ea667c144cf431e9b1a9ca503947735",
"primaryStorageUuid": "1337db63a9c1489381a30cfc3bbb9965",
"vmInstanceUuid": "1ea667c144cf431e9b1a9ca503947735",
"diskOfferingUuid": "02e831a9c4634cf898e65ef074fdacf0",
"rootImageUuid": "309fa4ff1c1244dab6a350260e7c5838",
"installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-627b25aebb5143a9a98bb3cab47341cf/627b25aebb5143a9a98bb3cab47341cf.qcow2",
"type": "Root",
"format": "qcow2",
"size": 1.073741824E11,
"actualSize": 2.147483648E10,
"deviceId": 0.0,
"state": "Enabled",
"status": "Ready",
"createDate": "Apr 24, 2017 7:11:29 PM",
"lastOpDate": "Apr 24, 2017 7:11:29 PM"
}
]
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 0.6 |
#error
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 0.6 |
| description | String | The brief description of the error. | 0.6 |
| details | String | The details about the error. | 0.6 |
| elaboration | String | The reserved field. Default value: null. | 0.6 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 0.6 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 0.6 |
SDK Sample
Java
SDK
DeleteVmSshKeyAction action = new DeleteVmSshKeyAction();
action.uuid = "59ab1ff13ea947769b7522cd95311837";
action.sessionId = "ad1c38b4ce1343a28a06d3eb08ae1123";
DeleteVmSshKeyAction.Result res = action.call();Python
SDK
DeleteVmSshKeyAction action = DeleteVmSshKeyAction()
action.uuid = "22b709aa71ec47a2a0e0f758b55e844e"
action.sessionId = "f70cfa4d6dc04f2aa567621501247954"
DeleteVmSshKeyAction.Result res = action.call()