Harness

Cloud Cost Details

Fetch cloud cost data for cost analysis

Returns an overview of the cost

Returns total cost, cost trend, and the time period based on the specified query parameters.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

perspectiveId
required
string

Perspective identifier of the cost details

startTime
string

Start time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today - 7days

endTime
string

End time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today

Request Body schema: application/json

Cost details query parameters.

Array of objects (FieldFilter)

Filters to be applied on the response.

groupBy
Array of strings

Fields on which the response will be grouped by.

Items Enum: "PERSPECTIVE_ID" "ANOMALY_ID" "WORKLOAD" "WORKLOAD_TYPE" "CLUSTER_ID" "CLUSTER_NAME" "CLUSTER_NAMESPACE" "CLUSTER_NAMESPACE_ID" "CLUSTER_WORKLOAD" "CLUSTER_WORKLOAD_ID" "CLUSTER_NODE" "CLUSTER_POD" "CLUSTER_PARENT_INSTANCE_ID" "CLUSTER_STORAGE" "CLUSTER_APPLICATION" "CLUSTER_ENVIRONMENT" "CLUSTER_SERVICE" "CLUSTER_CLOUD_PROVIDER" "CLUSTER_ECS_SERVICE" "CLUSTER_ECS_SERVICE_ID" "CLUSTER_ECS_TASK" "CLUSTER_ECS_TASK_ID" "CLUSTER_ECS_LAUNCH_TYPE" "CLUSTER_ECS_LAUNCH_TYPE_ID" "NAMESPACE" "SERVICE" "SERVICE_NAME" "GCP_PRODUCT" "GCP_PROJECT" "GCP_SKU_ID" "GCP_SKU_DESCRIPTION" "AWS_ACCOUNT" "AWS_SERVICE" "AWS_INSTANCE_TYPE" "AWS_USAGE_TYPE" "AWS_BILLING_ENTITY" "AWS_LINE_ITEM_TYPE" "AZURE_SUBSCRIPTION_GUID" "AZURE_METER_NAME" "AZURE_METER_CATEGORY" "AZURE_METER_SUBCATEGORY" "AZURE_RESOURCE_ID" "AZURE_RESOURCE_GROUP_NAME" "AZURE_RESOURCE_TYPE" "AZURE_RESOURCE" "AZURE_SERVICE_NAME" "AZURE_SERVICE_TIER" "AZURE_INSTANCE_ID" "AZURE_SUBSCRIPTION_NAME" "AZURE_PUBLISHER_NAME" "AZURE_PUBLISHER_TYPE" "AZURE_RESERVATION_ID" "AZURE_RESERVATION_NAME" "AZURE_FREQUENCY" "COMMON_PRODUCT" "COMMON_REGION" "COMMON_NONE" "CLOUD_PROVIDER" "STATUS" "REGION" "ANOMALY_TIME" "ACTUAL_COST" "EXPECTED_COST" "ANOMALOUS_SPEND" "COST_IMPACT" "TOTAL_COST" "IDLE_COST" "UNALLOCATED_COST" "ALL" "RULE_NAME" "RULE_SET_NAME"
timeResolution
string

Only applicable for Time Series Endpoints, defaults to DAY

Enum: "HOUR" "DAY" "MONTH" "WEEK" "QUARTER" "YEAR"
limit
integer <int32>

Limit on the number of cost values returned, 0 by default.

sortOrder
string

Order of sorting on cost, Descending by default.

Enum: "ASCENDING" "DESCENDING"
offset
integer <int32>

Offset on the cost values returned, 10 by default.

skipRoundOff
boolean

Skip Rounding off the cost values returned, false by default.

Responses
400

Bad Request

500

Internal server error

default

Returns total cost, cost trend, and the time period based on the specified query parameters.

post/ccm/api/costdetails/overview
Request samples
application/json
{
  • "filters": [
    ],
  • "groupBy": [
    ],
  • "timeResolution": "HOUR",
  • "limit": 0,
  • "sortOrder": "ASCENDING",
  • "offset": 0,
  • "skipRoundOff": true
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Returns cluster data in a tabular format

Returns cluster data based on the specified query parameters.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

startTime
string

Start time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today - 7days

endTime
string

End time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today

Request Body schema: application/json
required

Cost details query parameters.

Array of objects (CCMAggregation)

Fields which will be aggregated in the response

Array of objects (FieldFilter)

Filters to be applied on the response.

groupBy
Array of strings

Fields on which the response will be grouped by.

Items Enum: "PERSPECTIVE_ID" "ANOMALY_ID" "WORKLOAD" "WORKLOAD_TYPE" "CLUSTER_ID" "CLUSTER_NAME" "CLUSTER_NAMESPACE" "CLUSTER_NAMESPACE_ID" "CLUSTER_WORKLOAD" "CLUSTER_WORKLOAD_ID" "CLUSTER_NODE" "CLUSTER_POD" "CLUSTER_PARENT_INSTANCE_ID" "CLUSTER_STORAGE" "CLUSTER_APPLICATION" "CLUSTER_ENVIRONMENT" "CLUSTER_SERVICE" "CLUSTER_CLOUD_PROVIDER" "CLUSTER_ECS_SERVICE" "CLUSTER_ECS_SERVICE_ID" "CLUSTER_ECS_TASK" "CLUSTER_ECS_TASK_ID" "CLUSTER_ECS_LAUNCH_TYPE" "CLUSTER_ECS_LAUNCH_TYPE_ID" "NAMESPACE" "SERVICE" "SERVICE_NAME" "GCP_PRODUCT" "GCP_PROJECT" "GCP_SKU_ID" "GCP_SKU_DESCRIPTION" "AWS_ACCOUNT" "AWS_SERVICE" "AWS_INSTANCE_TYPE" "AWS_USAGE_TYPE" "AWS_BILLING_ENTITY" "AWS_LINE_ITEM_TYPE" "AZURE_SUBSCRIPTION_GUID" "AZURE_METER_NAME" "AZURE_METER_CATEGORY" "AZURE_METER_SUBCATEGORY" "AZURE_RESOURCE_ID" "AZURE_RESOURCE_GROUP_NAME" "AZURE_RESOURCE_TYPE" "AZURE_RESOURCE" "AZURE_SERVICE_NAME" "AZURE_SERVICE_TIER" "AZURE_INSTANCE_ID" "AZURE_SUBSCRIPTION_NAME" "AZURE_PUBLISHER_NAME" "AZURE_PUBLISHER_TYPE" "AZURE_RESERVATION_ID" "AZURE_RESERVATION_NAME" "AZURE_FREQUENCY" "COMMON_PRODUCT" "COMMON_REGION" "COMMON_NONE" "CLOUD_PROVIDER" "STATUS" "REGION" "ANOMALY_TIME" "ACTUAL_COST" "EXPECTED_COST" "ANOMALOUS_SPEND" "COST_IMPACT" "TOTAL_COST" "IDLE_COST" "UNALLOCATED_COST" "ALL" "RULE_NAME" "RULE_SET_NAME"
timeResolution
string

Only applicable for Time Series Endpoints, defaults to DAY

Enum: "HOUR" "DAY" "MONTH" "WEEK" "QUARTER" "YEAR"
limit
integer <int32>

Limit on the number of cost values returned, 0 by default.

sortOrder
string

Order of sorting on cost, Descending by default.

Enum: "ASCENDING" "DESCENDING"
offset
integer <int32>

Offset on the cost values returned, 10 by default.

skipRoundOff
boolean

Skip Rounding off the cost values returned, false by default.

selectedLabels
Array of strings

The response will contain values corresponding to these labels

Responses
400

Bad Request

500

Internal server error

default

Returns cluster data in a tabular format based on the specified query parameters.

post/ccm/api/costdetails/clusterData
Request samples
application/json
{
  • "aggregations": [
    ],
  • "filters": [
    ],
  • "groupBy": [
    ],
  • "timeResolution": "HOUR",
  • "limit": 0,
  • "sortOrder": "ASCENDING",
  • "offset": 0,
  • "skipRoundOff": true,
  • "selectedLabels": [
    ]
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Returns cost details in a tabular format

Returns cost details in a tabular format based on the specified query parameters.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

perspectiveId
required
string

Perspective identifier of the cost details

startTime
string

Start time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today - 7days

endTime
string

End time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today

Request Body schema: application/json
required

Cost details query parameters.

Array of objects (FieldFilter)

Filters to be applied on the response.

groupBy
Array of strings

Fields on which the response will be grouped by.

Items Enum: "PERSPECTIVE_ID" "ANOMALY_ID" "WORKLOAD" "WORKLOAD_TYPE" "CLUSTER_ID" "CLUSTER_NAME" "CLUSTER_NAMESPACE" "CLUSTER_NAMESPACE_ID" "CLUSTER_WORKLOAD" "CLUSTER_WORKLOAD_ID" "CLUSTER_NODE" "CLUSTER_POD" "CLUSTER_PARENT_INSTANCE_ID" "CLUSTER_STORAGE" "CLUSTER_APPLICATION" "CLUSTER_ENVIRONMENT" "CLUSTER_SERVICE" "CLUSTER_CLOUD_PROVIDER" "CLUSTER_ECS_SERVICE" "CLUSTER_ECS_SERVICE_ID" "CLUSTER_ECS_TASK" "CLUSTER_ECS_TASK_ID" "CLUSTER_ECS_LAUNCH_TYPE" "CLUSTER_ECS_LAUNCH_TYPE_ID" "NAMESPACE" "SERVICE" "SERVICE_NAME" "GCP_PRODUCT" "GCP_PROJECT" "GCP_SKU_ID" "GCP_SKU_DESCRIPTION" "AWS_ACCOUNT" "AWS_SERVICE" "AWS_INSTANCE_TYPE" "AWS_USAGE_TYPE" "AWS_BILLING_ENTITY" "AWS_LINE_ITEM_TYPE" "AZURE_SUBSCRIPTION_GUID" "AZURE_METER_NAME" "AZURE_METER_CATEGORY" "AZURE_METER_SUBCATEGORY" "AZURE_RESOURCE_ID" "AZURE_RESOURCE_GROUP_NAME" "AZURE_RESOURCE_TYPE" "AZURE_RESOURCE" "AZURE_SERVICE_NAME" "AZURE_SERVICE_TIER" "AZURE_INSTANCE_ID" "AZURE_SUBSCRIPTION_NAME" "AZURE_PUBLISHER_NAME" "AZURE_PUBLISHER_TYPE" "AZURE_RESERVATION_ID" "AZURE_RESERVATION_NAME" "AZURE_FREQUENCY" "COMMON_PRODUCT" "COMMON_REGION" "COMMON_NONE" "CLOUD_PROVIDER" "STATUS" "REGION" "ANOMALY_TIME" "ACTUAL_COST" "EXPECTED_COST" "ANOMALOUS_SPEND" "COST_IMPACT" "TOTAL_COST" "IDLE_COST" "UNALLOCATED_COST" "ALL" "RULE_NAME" "RULE_SET_NAME"
timeResolution
string

Only applicable for Time Series Endpoints, defaults to DAY

Enum: "HOUR" "DAY" "MONTH" "WEEK" "QUARTER" "YEAR"
limit
integer <int32>

Limit on the number of cost values returned, 0 by default.

sortOrder
string

Order of sorting on cost, Descending by default.

Enum: "ASCENDING" "DESCENDING"
offset
integer <int32>

Offset on the cost values returned, 10 by default.

skipRoundOff
boolean

Skip Rounding off the cost values returned, false by default.

Responses
400

Bad Request

500

Internal server error

default

Returns cost details in a tabular format based on the specified query parameters.

post/ccm/api/costdetails/tabularformat
Request samples
application/json
{
  • "filters": [
    ],
  • "groupBy": [
    ],
  • "timeResolution": "HOUR",
  • "limit": 0,
  • "sortOrder": "ASCENDING",
  • "offset": 0,
  • "skipRoundOff": true
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Returns cost details in a time series format

Returns cost details in a time series format based on the specified query parameters.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

perspectiveId
required
string

Perspective identifier of the cost details

startTime
string

Start time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today - 7days

endTime
string

End time of the cost details. Should use org.joda.time.DateTime parsable format. Example, '2022-01-31', '2022-01-31T07:54Z' or '2022-01-31T07:54:51.264Z'. Defaults to Today

Request Body schema: application/json
required

Cost details query parameters.

Array of objects (FieldFilter)

Filters to be applied on the response.

groupBy
Array of strings

Fields on which the response will be grouped by.

Items Enum: "PERSPECTIVE_ID" "ANOMALY_ID" "WORKLOAD" "WORKLOAD_TYPE" "CLUSTER_ID" "CLUSTER_NAME" "CLUSTER_NAMESPACE" "CLUSTER_NAMESPACE_ID" "CLUSTER_WORKLOAD" "CLUSTER_WORKLOAD_ID" "CLUSTER_NODE" "CLUSTER_POD" "CLUSTER_PARENT_INSTANCE_ID" "CLUSTER_STORAGE" "CLUSTER_APPLICATION" "CLUSTER_ENVIRONMENT" "CLUSTER_SERVICE" "CLUSTER_CLOUD_PROVIDER" "CLUSTER_ECS_SERVICE" "CLUSTER_ECS_SERVICE_ID" "CLUSTER_ECS_TASK" "CLUSTER_ECS_TASK_ID" "CLUSTER_ECS_LAUNCH_TYPE" "CLUSTER_ECS_LAUNCH_TYPE_ID" "NAMESPACE" "SERVICE" "SERVICE_NAME" "GCP_PRODUCT" "GCP_PROJECT" "GCP_SKU_ID" "GCP_SKU_DESCRIPTION" "AWS_ACCOUNT" "AWS_SERVICE" "AWS_INSTANCE_TYPE" "AWS_USAGE_TYPE" "AWS_BILLING_ENTITY" "AWS_LINE_ITEM_TYPE" "AZURE_SUBSCRIPTION_GUID" "AZURE_METER_NAME" "AZURE_METER_CATEGORY" "AZURE_METER_SUBCATEGORY" "AZURE_RESOURCE_ID" "AZURE_RESOURCE_GROUP_NAME" "AZURE_RESOURCE_TYPE" "AZURE_RESOURCE" "AZURE_SERVICE_NAME" "AZURE_SERVICE_TIER" "AZURE_INSTANCE_ID" "AZURE_SUBSCRIPTION_NAME" "AZURE_PUBLISHER_NAME" "AZURE_PUBLISHER_TYPE" "AZURE_RESERVATION_ID" "AZURE_RESERVATION_NAME" "AZURE_FREQUENCY" "COMMON_PRODUCT" "COMMON_REGION" "COMMON_NONE" "CLOUD_PROVIDER" "STATUS" "REGION" "ANOMALY_TIME" "ACTUAL_COST" "EXPECTED_COST" "ANOMALOUS_SPEND" "COST_IMPACT" "TOTAL_COST" "IDLE_COST" "UNALLOCATED_COST" "ALL" "RULE_NAME" "RULE_SET_NAME"
timeResolution
string

Only applicable for Time Series Endpoints, defaults to DAY

Enum: "HOUR" "DAY" "MONTH" "WEEK" "QUARTER" "YEAR"
limit
integer <int32>

Limit on the number of cost values returned, 0 by default.

sortOrder
string

Order of sorting on cost, Descending by default.

Enum: "ASCENDING" "DESCENDING"
offset
integer <int32>

Offset on the cost values returned, 10 by default.

skipRoundOff
boolean

Skip Rounding off the cost values returned, false by default.

Responses
400

Bad Request

500

Internal server error

default

Returns cost details in a time series format based on the specified query parameters.

post/ccm/api/costdetails/timeseriesformat
Request samples
application/json
{
  • "filters": [
    ],
  • "groupBy": [
    ],
  • "timeResolution": "HOUR",
  • "limit": 0,
  • "sortOrder": "ASCENDING",
  • "offset": 0,
  • "skipRoundOff": true
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to Cloud Cost Overview