ReadKeyRequest() Parent topic

Description

Read a device key request from a virtual machine.

Interface

https://[SecureCloudService]/broker/API.svc/v3.5/vm/runningVM/keyRequest/{requestID}
Method: GET

Parameters

Parameter
Data Type
Description
Required?
requestID
String
The GUID of the key request.
Yes

Response

Expected HTTP response code: 200 (OK)
Refer to the following data type: RunningVMKeyRequest．

Example Request

[GET]
https://ms.sample.securecloud.com/broker/API.svc/v3.5/runningVM/
      keyRequest/12345678-a145-4bde-998c-3c5d36b73243

Example Response

<?xml version="1.0" encoding="utf-8"?>
<runningVMKeyRequest version="3.5" requestID="12345678-a145-4bde-998c-3c5d36b73243"
requested="2012-11-01T02:31:40.95" deviceKeyRequestState="approved"
href="https://ms.sample.securecloud.com/Broker/API.svc/v3.5/runningVM/
      keyRequest/12345678-a145-4bde-998c-3c5d36b73243">
      <ruleEvaluationList failedCount="0" passedCount="0" infoCount="0">
            <ruleEvaluation id="" name="" href="" description="">
                  <ruleEvaluationCatagory name="" type=""/>
                  <ruleEvaluationData success="Passed" evaluator="lessThan" dataType="Text">
                        <expected>xxx</expected>
                        <actual>xxx</actual>
                  </ruleEvaluationData>
            </ruleEvaluation>
      </ruleEvaluationList>
</runningVMKeyRequest>