You can use the REST API catalog service to check the status of your Amazon EC2 Machine request.

Input

Use the supported input parameters to control the command output.

Parameter

Description

URL

https://$host/catalog-service/api/consumer/requests/requestId

$host

Specifies the host name and fully qualified domain name or IP address of the vRealize Automation identity server.

$token

Specifies a valid HTTP bearer token with necessary credentials.

requestId

Specifies the ID of the request to check.

Output

The command output contains property names and values based on the command input parameters.

Property

Description

version

Displays the object version number.

state

Specifies the item state, such as submitted.

approvalStatus

Specifies a status indicating whether this request has been approved, rejected, or is still pending some form of approval.

waitingStatus

Specifies a status indicating whether this request is waiting on any external users or services before it is able to progress.

requestNumber

Specifies a more user-friendly identifier for this request.

executionStatus

Specifies the current execution status of the request.

stateName

Specifies the localized state name.

phase

Specifies the current phase of the request, which is more coarse grained and easier for users to understand.

id

Specifies the unique identifier of this resource.

iconId

Specifies an icon for this request based on the requested object type.

description

Contains a brief description of this request.

reasons

Specifies the business reasons entered by the requestor or owner of this request.

requestedFor

Specifies the ID of the user for whom this request is logged.

requestedBy

Specifies the ID of the user who actually submitted the request

organization

Subtenant and/or tenant owner of this request.

requestorEntitlementId

Specified the value of the requestorEntitlement setting.

preApprovalId

Specifies the ID of the preApproval setting.

postApprovalId

Specifies the ID of the approval generated for the post-provisioning workflow step.

dateCreated

Specifies the date when this request was sent to the catalog.

lastUpdated

Specifies the date when this request was last updated.

dateSubmitted

Specifies the date when this request was first submitted.

dateApproved

Specifies the date when this request was approved.

dateCompleted

Specifies the date when this request was completed.

quote

Contains a quote made by the provider defining the estimated cost(s) associated with the request and/or any resources provisioned as a result of the request.

requestCompletion

Contains additional request completion information.

requestData

Contains a map of the provider-specific field-value pairs collected for this request.

retriesRemaning

Specifies the number of attempts remaining to move this request from its current state to the next state in the request workflow.

Some state transitions require calls to external services. These calls may fail due to transient errors such as momentary network errors. In these cases, the catalog will retry the call a number of times before failing.

This property defines the number of retries remaining for the current state transition. When it reaches 0, the catalog will stop retrying and mark the request as failed. This property is reset to the default number of retries for every new operation that is triggered.

requestedItemName

Specifies the item name.

requestedItemDescription

Specifies the item description.

curl Command

The following example command checks the status of an Amazon machine request where 25211c6c-f09d-4e2b-9be4-7b09c47c9f6c is the value of the request ID.

curl --insecure -H "Content-Type: application/json" 
-H "Authorization: Bearer $token"
https://$host/catalog-service/api/consumer/requests/25211c6c-f09d-4e2b-9be4-7b09c47c9f6c

JSON Output

The following JSON output is returned based on the command input.

{
  "@type" : "CatalogItemRequest",
  "id" : "25211c6c-f09d-4e2b-9be4-7b09c47c9f6c",
  "iconId" : "cafe_default_icon_genericCatalogItem",
  "version" : 5,
  "requestNumber" : 14,
  "state" : "SUCCESSFUL",
  "description" : "CLI EC2 description",
  "reasons" : "CLI EC2 reason",
  "requestedFor" : "Auto.admin@abx.local",
  "requestedBy" : "Auto.admin@abx.local",
  "organization" : {
    "tenantRef" : "sqa",
    "tenantLabel" : "SQA",
    "subtenantRef" : "b475039a-94dd-4bf3-97f6-8596f8cf8818",
    "subtenantLabel" : "Business Group"
  },
  "requestorEntitlementId" : "04f4588f-548a-4bc6-baf8-c22241918322",
  "preApprovalId" : null,
  "postApprovalId" : null,
  "dateCreated" : "2014-09-11T22:29:02.190Z",
  "lastUpdated" : "2014-09-11T22:31:05.780Z",
  "dateSubmitted" : "2014-09-11T22:29:02.190Z",
  "dateApproved" : null,
  "dateCompleted" : "2014-09-11T22:31:05.779Z",
  "quote" : {
    "leaseRate" : {
      "type" : "moneyTimeRate",
      "cost" : {
        "type" : "money",
        "currencyCode" : null,
        "amount" : 3.0
      },
      "basis" : {
        "type" : "timeSpan",
        "unit" : "DAYS",
        "amount" : 1
      }
    }
  },
  "requestCompletion" : {
    "requestCompletionState" : "SUCCESSFUL",
    "completionDetails" : "Request succeeded. Created mp108."
  },
  "requestData" : {
    "entries" : [ {
      "key" : "provider-blueprintId",
      "value" : {
        "type" : "string",
        "value" : "1701645d-7e43-479f-930c-fbef58d13d50"
      }
    }, {
      "key" : "provider-provisioningGroupId",
      "value" : {
        "type" : "string",
        "value" : "b475039a-94dd-4bf3-97f6-8596f8cf8818"
      }
    }, {
      "key" : "provider-__Notes",
      "value" : {
        "type" : "string",
        "value" : "CLI EC2 description"
      }
    }, {
      "key" : "provider-Cafe.Shim.VirtualMachine.Reason",
      "value" : {
        "type" : "string",
        "value" : "CLI EC2 reason"
      }
    }, {
      "key" : "provider-__amazon.instanceType",
      "value" : {
        "type" : "string",
        "value" : "t1.micro"
      }
    } ]
  },
  "retriesRemaining" : 3,
  "phase" : "SUCCESSFUL",
  "executionStatus" : "STOPPED",
  "waitingStatus" : "NOT_WAITING",
  "approvalStatus" : "POST_APPROVED",
  "catalogItemRef" : {
    "id" : "6cca9fd9-83b7-4f5d-8884-fb8a005fc656",
    "label" : "EC2 Blueprint"
  }
}