IdentifyHost

API Request

URLs

PUT zstack/v1/hosts/kvm/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "identifyHost": {
    "interval": 60
  },
  "systemTags": [],
  "userTags": []
}

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"identifyHost":{"interval":60}}' \
http://localhost:8080/zstack/v1/hosts/kvm/b235f9c96dc138a49212c7819d843f48/actions

Parameter List

Name	Type	Location	Description	Starting Version
uuid	String	url	UUID of the resource. Uniquely identifies the resource.	0.6
interval (Optional)	Long	body (contained in the `identifyHost` structure)	Optional. The interval.	0.6
systemTags (Optional)	List	body	Optional. The system tags.	0.6
userTags (Optional)	List	body	Optional. The user tags.	0.6

API Response

On success, this API returns an empty JSON structure {}. On error, the returned JSON structure contains 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 Examples

Java SDK

IdentifyHostAction action = new IdentifyHostAction();
action.uuid = "b235f9c96dc138a49212c7819d843f48";
action.interval = 60;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
IdentifyHostAction.Result res = action.call();

Python SDK

IdentifyHostAction action = IdentifyHostAction()
action.uuid = "b235f9c96dc138a49212c7819d843f48"
action.interval = 60
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
IdentifyHostAction.Result res = action.call()

PreviousGetHostTask NextUpdateHostname