API Reference | ZStack ZSphere · ZVF | ZStack Resource Center

API Request

URLs

GET zstack/v1/primary-storage/vm-instances/metadata

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/primary-storage/vm-instances/metadata?uuid=ff01ec80fd11327cba7519b66119d900

Parameters

Name	Type	Location	Description	Since
uuid	String	query	virtual machine UUID	5.0.0
systemTags (Optional)	List	query	System tags	5.0.0
userTags (Optional)	List	query	User tags	5.0.0

API Response

When this API succeeds, it returns an empty JSON structure {}. When an error occurs, 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 Example

Java SDK

GetVmInstanceMetadataFromPrimaryStorageAction action = new GetVmInstanceMetadataFromPrimaryStorageAction();
action.uuid = "ff01ec80fd11327cba7519b66119d900";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVmInstanceMetadataFromPrimaryStorageAction.Result res = action.call();

Python SDK

action = GetVmInstanceMetadataFromPrimaryStorageAction()
action.uuid = "ff01ec80fd11327cba7519b66119d900"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()