Get itemized costs by deployments. Currently unavailable in self-hosted ECE.

edit

Get itemized costs by deployments. Currently unavailable in self-hosted ECE.

edit

EXPERIMENTAL (it may change in future versions): Retrieves the itemized costs for the given deployment.

Request

edit

GET /api/v1/billing/costs/{organization_id}/deployments/{deployment_id}/items

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Id of a Deployment
`organization_id`	`string`	Y	Identifier for the organization

Query parameters

edit

Name	Type	Required	Description
`from`	`string`	N	A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month.
`to`	`string`	N	A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.

Headers

edit

Name	Type	Required	Description
`Accept`	`string`	N	Determines the response body format. Can be either application/json or text/csv.

Responses

edit

200

(ItemsCosts)

The costs associated to a set items billed for a single deployment.

400

(BasicFailedReply)

The specified date range is invalid. (code: costs.invalid_date_range)

Headers

x-cloud-error-codes (string; allowed values: [costs.invalid_date_range]): The error codes associated with the response

403

(BasicFailedReply)

The current user does not have access to the requested organization. (code: organization.invalid_access)

Headers

x-cloud-error-codes (string; allowed values: [organization.invalid_access]): The error codes associated with the response

404

(BasicFailedReply)

The organization was not found. (code: organization.not_found)
The Elasticsearch cluster was not found. (code: billing_service.es_cluster_id_not_found)

Headers

x-cloud-error-codes (string; allowed values: [organization.not_found, billing_service.es_cluster_id_not_found]): The error codes associated with the response

500

(BasicFailedReply)

An error occurred when fetching the itemized costs for the given deployment of the organization. (code: billing_service.failed_request)

Headers

x-cloud-error-codes (string; allowed values: [billing_service.failed_request]): The error codes associated with the response

Request example

edit

curl -XGET https://{{hostname}}/api/v1/billing/costs/{organization_id}/deployments/{deployment_id}/items \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H Accept: string

« Get charts by deployment. Currently unavailable in self-hosted ECE. Get itemized costs for the organization. Currently unavailable in self-hosted ECE. »