list-compute-usage-records¶

Description¶

Lists all compute usage records for requested duration.

list-compute-usage-records is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-compute-usage-records
--from-timestamp <value>
--to-timestamp <value>
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--from-timestamp (datetime)

The beginning timestamp for the search range (inclusive).

--to-timestamp (datetime)

The ending timestamp for the search range (exclusive).

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 100 is used.

--starting-token (string)

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

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

records -> (array)

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

item -> (object)

Record of compute usage values aggregated hourly.

quantityType -> (string)

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

environmentName -> (string)

Name of the environment.

environmentCrn -> (string)

CRN of the environment.

clusterName -> (string)

Name of the cluster.

clusterCrn -> (string)

CRN of the cluster.

cloudProvider -> (string)

Cloud Provider on which cluster is running.

serviceFeature -> (string)

Service Feature of the cluster.

usageStartTimestamp -> (string)

Timestamp of start of the usage.

usageEndTimestamp -> (string)

Timestamp of end of the usage.

quantity -> (double)

Quantity of usage of the cluster.

grossCharge -> (double)

Number of credits consumed by this usage.

listRate -> (double)

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

hours -> (double)

Total number of hours for which instances were running.

instanceType -> (string)

Type of instance of the cluster.

instanceCount -> (integer)

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

clusterType -> (string)

Type of the cluster.

userTags -> (string)

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"}”

clusterTemplate -> (string)

The template with which the cluster is created.

nextPageToken -> (string)

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

Form Factors¶

public