CoreService

<back to all web services

GetBillableResources

Statistics

Returns billable resource counts

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/statistics/billableresourcesReturns billable resource counts
GET/statistics/billableresourcesReturns billable resource counts
import Foundation
import ServiceStack

/**
* Returns billable resource counts
*/
// @Api(Description="Returns billable resource counts")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(BillableResourceSummaryDto), StatusCode=200)
public class GetBillableResources : IBaseRequest, IHasTenantName, IGet, Codable
{
    // @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    // @Validate(Validator="NotEmpty")
    public var tenantName:String

    required public init(){}
}

public class BillableResourceSummaryDto : Codable
{
    public var generatedOn:Date
    public var billableResources:[String:BillableResourceDto] = [:]

    required public init(){}
}

public class BillableResourceDto : Codable
{
    public var type:ObjectTypes
    public var totalCount:Int
    public var billableCount:Int
    public var billableResources:[HeaderDto] = []

    required public init(){}
}

public enum ObjectTypes : String, Codable
{
    case None
    case ConfigItem
    case Tenant
    case Collection
    case Resource
    case ComputeNode
    case VirtualMachine
    case PhysicalMachine
    case Disk
    case Subnet
    case IPAddress
    case Job
    case JobEvent
    case FreezePeriod
    case ResourceGroup
    case Deployment
    case ResourceGroupTemplate
    case DeploymentTemplate
    case ResourceProvider
    case GenericResource
    case Role
    case Permission
    case User
    case PatchingWindow
    case Update
    case ReportDefinition
    case TimeSeries
    case DataPoint
    case Action
    case ActionAssignment
    case UserNote
}

public class HeaderDto : IHasIdName, IHasObjectType, Codable
{
    public var id:String
    public var name:String
    public var displayName:String
    public var objectType:ObjectTypes

    required public init(){}
}


Swift GetBillableResources DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/statistics/billableresources HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"generatedOn":"0001-01-01T00:00:00.0000000Z","billableResources":{"String":{"type":"None","totalCount":0,"billableCount":0,"billableResources":[{"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","objectType":"None"}]}}}