Retrieve Plan Events

Article
08/24/2015

Applies To: Windows Azure Pack

Retrieves the list of plan events.

Request

Replace <UsageEndpoint> with the name of the computer that hosts the usage endpoint for the Windows Azure Pack.

Method	Request URI	HTTP version
GET	https://<UsageEndpoint>:30022/billing/plans	HTTP/1.1

URI Parameters

The following table describes the URI parameters.

URI parameter	Description
startId	The identifier of the first record to retrieve.
batchSize	The maximum number of records to retrieve.

Request Headers

The following table describes required and optional request headers.

Request header	Description
Authorization: Basic	Required. The basic authorization token.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 200 (OK).

For information about status codes, see Status and Error Codes (Windows Azure Pack Service Management).

Response Headers

The response for this operation includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Body

The following table describes the key elements of the response body.

Element name	Description
UsageEventList	A list of plan events. For more information, see UsageEvent (Usage Metering Object).

Example

The following code example shows a Get Plan Events request.

https://<Computer>:30022/billing/plans?startId=0&batchSize=1 HTTP/1.1
Accept: application/json
Authorization: basic <Token>
Host: <Computer>:30022
Connection: Keep-Alive

The following code example shows a Get Plan Events response.

[
  {
    "EventId": 1,
    "State": 0,
    "Method": "POST",
    "Entity": {
      "Id": "Goldas32o0zc",
      "DisplayName": "Gold",
      "State": 1,
      "ConfigState": 0,
      "QuotaSyncState": 2,
      "LastErrorMessage": null,
      "Advertisements": [
        {
          "LanguageCode": "en-us",
          "DisplayName": "Gold",
          "Description": null
        }
      ],
      "ServiceQuotas": [
        {
          "ServiceName": "webspaces",
          "ServiceInstanceId": "D0F438BD-15BF-4227-83E4-44083D8B885D",
          "ServiceDisplayName": null,
          "ServiceInstanceDisplayName": null,
          "ConfigState": 0,
          "QuotaSyncState": 2,
          "Settings": [

          ]
        },
        {
          "ServiceName": "sqlservers",
          "ServiceInstanceId": "3C554958-B011-42B1-AA15-9474E5A2A799",
          "ServiceDisplayName": null,
          "ServiceInstanceDisplayName": null,
          "ConfigState": 0,
          "QuotaSyncState": 2,
          "Settings": [

          ]
        },
        {
          "ServiceName": "mysqlservers",
          "ServiceInstanceId": "15E75A87-9241-4E49-8F30-5A8879A170A1",
          "ServiceDisplayName": null,
          "ServiceInstanceDisplayName": null,
          "ConfigState": 0,
          "QuotaSyncState": 2,
          "Settings": [

          ]
        },
        {
          "ServiceName": "servicebus",
          "ServiceInstanceId": "552FD589-CADA-4ACD-8423-40C9936E2A1B",
          "ServiceDisplayName": null,
          "ServiceInstanceDisplayName": null,
          "ConfigState": 0,
          "QuotaSyncState": 2,
          "Settings": [

          ]
        }
      ],
      "SubscriptionCount": 0,
      "MaxSubscriptionsPerAccount": 1,
      "AddOnReferences": [

      ],
      "AddOns": [

      ],
      "InvitationCode": null,
      "Price": null
    },
    "EntityParentId": null,
    "NotificationEventTimeCreated": "2013-08-21T12:31:44.797"
  }
]

Share via