Overview

Provides an interface to the consumption service.

Version information

Version : 0.9.128 (BETA)

License information

URI scheme

Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Lists compute usage records.

POST /api/v1/consumption/listComputeUsageRecords

Description

Lists all compute usage records for requested duration.

Parameters

Type Name Schema

Body

input
required

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

default

The default response on an error.

Definitions

ComputeUsageRecord

Record of compute usage values aggregated hourly.

Name Description Schema

cloudProvider
optional

Cloud Provider on which cluster is running.

string

clusterCrn
optional

CRN of the cluster.

string

clusterName
optional

Name of the cluster.

string

clusterTemplate
optional

The template with which the cluster is created.

string

clusterType
optional

Type of the cluster.

string

environmentCrn
optional

CRN of the environment.

string

environmentName
optional

Name of the environment.

string

grossCharge
optional

Number of credits consumed by this usage.

number (double)

hours
optional

Total number of hours for which instances were running.

number (double)

instanceCount
optional

Total number of instances in the cluster which were in use.

integer (int32)

instanceType
optional

Type of instance of the cluster.

string

listRate
optional

Rate in credits at which usage is charged for given cluster type, instance type and cloud provider.

number (double)

quantity
optional

Quantity of usage of the cluster.

number (double)

quantityType
optional

Type of usage by the cluster (Eg: INSTANCE_USAGE, COMPUTE_USAGE).

string

serviceFeature
optional

Service Feature of the cluster.

string

usageEndTimestamp
optional

Timestamp of end of the usage.

string

usageStartTimestamp
optional

Timestamp of start of the usage.

string

userTags
optional

The tags assigned to a cluster. The format of this is a map serialized into a string as json. e.g.: "tags": "{"key1":"value1","key2":"value2"}"

string

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

ListComputeUsageRecordsRequest

Request object for ListComputeUsageRecords method.

Name Description Schema

fromTimestamp
required

The beginning timestamp for the search range (inclusive).

string (date-time)

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 10000

integer (int32)

pageToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

toTimestamp
required

The ending timestamp for the search range (exclusive).

string (date-time)

ListComputeUsageRecordsResponse

Response object for ListComputeUsageRecords method.

Name Description Schema

nextPageToken
optional

The token to use when requesting the next set of results. If not present, there are no additional results.

string

records
optional

The list of compute usage records in the requested time duration.

< ComputeUsageRecord > array


Copyright © 2024 Cloudera, Inc. All rights reserved.