CheckKVMHostConfigFile

API Request

URLs

POST /v1/hosts/kvm/from-file/check

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "hostInfo": "FILE CONTENT ENCODE BY BASE64"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"hostInfo":"FILE CONTENT ENCODE BY BASE64"}}' http://localhost:8080/zstack/v1/hosts/kvm/from-file/check

Request Parameters

Name	Type	Location	Description	Starting Version
hostInfo	String	body (contained in the params structure)	The host information encoded in Base64 format.	3.1.0
systemTags	List	body	Optional. The system tags.	3.1.0
userTags	List	body	Optional. The user tags.	3.1.0

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

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

SDK Sample

Java SDK

CheckKVMHostConfigFileAction action = new CheckKVMHostConfigFileAction();
action.hostInfo = "FILE CONTENT ENCODE BY BASE64";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CheckKVMHostConfigFileAction.Result res = action.call();

Python SDK

CheckKVMHostConfigFileAction action = CheckKVMHostConfigFileAction()
action.hostInfo = "FILE CONTENT ENCODE BY BASE64"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CheckKVMHostConfigFileAction.Result res = action.call()

PreviousAddKVMHostFromConfigFile NextSetServiceTypeOnHostNetworkInterface