GET
/v1/collector
¶Unused function, hack to let pecan route requests to subcontrollers.
GET
/v1/collector/mappings
¶Return the list of every services mapped to a collector.
Parameters: |
|
---|---|
Return: | Service to collector mappings collection. |
Return type: |
GET
/v1/collector/mappings/
(service)¶Return a service to collector mapping.
Parameters: |
|
---|---|
Return type: |
POST
/v1/collector/mappings
¶Create a service to collector mapping.
Parameters: |
|
---|---|
Return type: |
DELETE
/v1/collector/mappings
¶Delete a service to collector mapping.
Parameters: |
|
---|
GET
/v1/collector/states
¶Query the enable state of a collector.
Parameters: |
|
---|---|
Return: | State of the collector. |
Return type: |
PUT
/v1/collector/states
¶Set the enable state of a collector.
Parameters: |
|
---|---|
Return: | State of the collector. |
Return type: |
CollectorInfos
¶Type describing a collector module.
Data samples:
{
"enabled": true,
"name": "gnocchi"
}
<value>
<name>gnocchi</name>
<enabled>true</enabled>
</value>
enabled
¶Type: | bool |
---|
State of the collector.
name
¶Type: | unicode |
---|
Name of the collector.
ServiceToCollectorMapping
¶Type describing a service to collector mapping.
Data samples:
{
"collector": "gnocchi",
"service": "compute"
}
<value>
<service>compute</service>
<collector>gnocchi</collector>
</value>
collector
¶Type: | unicode |
---|
Name of the collector.
service
¶Type: | unicode |
---|
Name of the service.
ServiceToCollectorMappingCollection
¶Type describing a service to collector mapping collection.
Data samples:
{
"mappings": [
{
"collector": "gnocchi",
"service": "compute"
}
]
}
<value>
<mappings>
<item>
<service>compute</service>
<collector>gnocchi</collector>
</item>
</mappings>
</value>
mappings
¶Type: | list(ServiceToCollectorMapping) |
---|
List of service to collector mappings.
GET
/v1/info/config
¶Return current configuration.
Return type: | dict(str : None ) |
---|
GET
/v1/info/metric
¶Get the metric list.
Return: | List of every metrics. |
---|---|
Return type: | CloudkittyMetricInfoCollection |
GET
/v1/info/metric/
(metric_name)¶Return a metric.
Parameters: |
|
---|---|
Return type: |
CloudkittyMetricInfo
¶Type describing a metric info in CloudKitty.
Data samples:
{
"metadata": [
"resource_id",
"project_id",
"qty",
"unit"
],
"metric_id": "image.size",
"unit": "MiB"
}
<value>
<metric_id>image.size</metric_id>
<metadata>
<item>resource_id</item>
<item>project_id</item>
<item>qty</item>
<item>unit</item>
</metadata>
<unit>MiB</unit>
</value>
metadata
¶Type: | list(unicode) |
---|
List of metric metadata
metric_id
¶Type: | unicode |
---|
Name of the metric.
unit
¶Type: | unicode |
---|
Metric unit
CloudkittyMetricInfoCollection
¶A list of CloudKittyMetricInfo.
Data samples:
{
"metrics": [
{
"metadata": [
"resource_id",
"project_id",
"qty",
"unit"
],
"metric_id": "image.size",
"unit": "MiB"
}
]
}
<value>
<metrics>
<item>
<metric_id>image.size</metric_id>
<metadata>
<item>resource_id</item>
<item>project_id</item>
<item>qty</item>
<item>unit</item>
</metadata>
<unit>MiB</unit>
</item>
</metrics>
</value>
GET
/v1/info/service
¶Get the service list (deprecated).
Return: | List of every services. |
---|---|
Return type: | CloudkittyMetricInfoCollection |
GET
/v1/info/service/
(service_name)¶Return a service (deprecated).
Parameters: |
|
---|---|
Return type: |
GET
/v1/rating/modules
¶return the list of loaded modules.
Return: | name of every loaded modules. |
---|---|
Return type: | CloudkittyModuleCollection |
GET
/v1/rating/modules/
(module_id)¶return a module
Return: | CloudKittyModule |
---|---|
Return type: | CloudkittyModule |
PUT
/v1/rating/modules
¶Change the state and priority of a module.
Parameters: |
|
---|---|
Return type: |
POST
/v1/rating/quote
¶Get an instant quote based on multiple resource descriptions.
Parameters: |
|
---|---|
Return: | Total price for these descriptions. |
Return type: |
|
GET
/v1/rating/reload_modules
¶Trigger a rating module list reload.
CloudkittyModule
¶A rating extension summary
Data samples:
{
"description": "Sample extension.",
"enabled": true,
"hot-config": false,
"priority": 2
}
<value>
<description>Sample extension.</description>
<enabled>true</enabled>
<hot-config>false</hot-config>
<priority>2</priority>
</value>
description
¶Type: | unicode |
---|
Short description of the extension.
enabled
¶Type: | bool |
---|
Extension status.
hot_config
¶Type: | bool |
---|
On-the-fly configuration support.
module_id
¶Type: | unicode |
---|
Name of the extension.
priority
¶Type: | int |
---|
Priority of the extension.
CloudkittyModuleCollection
¶A list of rating extensions.
Data samples:
{}
<value />
CloudkittyResource
¶Type describing a resource in CloudKitty.
Data samples:
{
"desc": {
"image_id": "a41fba37-2429-4f15-aa00-b5bc4bf557bf"
},
"service": "compute",
"volume": "1"
}
<value>
<service>compute</service>
<desc>
<item>
<key>image_id</key>
<value>a41fba37-2429-4f15-aa00-b5bc4bf557bf</value>
</item>
</desc>
<volume>1</volume>
</value>
desc
¶Type: | dict(unicode: None) |
---|
Description of the resources parameters.
service
¶Type: | unicode |
---|
Name of the service.
volume
¶Type: | Decimal |
---|
Volume of resources.
CloudkittyResourceCollection
¶A list of CloudKittyResources.
Data samples:
{}
<value />
GET
/v1/report/summary
¶Return the summary to pay for a given period.
Return type: | SummaryCollectionModel |
---|
GET
/v1/report/tenants
¶Return the list of rated tenants.
Return type: | list(unicode ) |
---|
GET
/v1/report/total
¶Return the amount to pay for a given period.
Return type: | Decimal |
---|
GET
/v1/storage/dataframes
¶Return a list of rated resources for a time period and a tenant.
Parameters: |
|
---|---|
Return: | Collection of DataFrame objects. |
Return type: |
RatedResource
¶Represents a rated CloudKitty resource.
Data samples:
{
"desc": {
"flavor": "m1.tiny",
"vcpus": "1"
},
"rating": "1.0",
"service": "compute",
"volume": "1.0"
}
<value>
<rating>1.0</rating>
<service>compute</service>
<desc>
<item>
<key>flavor</key>
<value>m1.tiny</value>
</item>
<item>
<key>vcpus</key>
<value>1</value>
</item>
</desc>
<volume>1.0</volume>
</value>
DataFrame
¶Type describing a stored data frame.
Data samples:
{
"begin": "2015-04-22T07:00:00",
"end": "2015-04-22T08:00:00",
"resources": [
{
"desc": {
"flavor": "m1.tiny",
"vcpus": "1"
},
"rating": "1.0",
"service": "compute",
"volume": "1.0"
}
],
"tenant_id": "69d12143688f413cbf5c3cfe03ed0a12"
}
<value>
<begin>2015-04-22T07:00:00</begin>
<end>2015-04-22T08:00:00</end>
<tenant_id>69d12143688f413cbf5c3cfe03ed0a12</tenant_id>
<resources>
<item>
<rating>1.0</rating>
<service>compute</service>
<desc>
<item>
<key>flavor</key>
<value>m1.tiny</value>
</item>
<item>
<key>vcpus</key>
<value>1</value>
</item>
</desc>
<volume>1.0</volume>
</item>
</resources>
</value>
begin
¶Type: | datetime |
---|
Begin date for the sample.
end
¶Type: | datetime |
---|
End date for the sample.
resources
¶Type: | list(RatedResource) |
---|
A resource list.
tenant_id
¶Type: | unicode |
---|
Tenant owner of the sample.
DataFrameCollection
¶A list of stored data frames.
Data samples:
{
"dataframes": [
{
"begin": "2015-04-22T07:00:00",
"end": "2015-04-22T08:00:00",
"resources": [
{
"desc": {
"flavor": "m1.tiny",
"vcpus": "1"
},
"rating": "1.0",
"service": "compute",
"volume": "1.0"
}
],
"tenant_id": "69d12143688f413cbf5c3cfe03ed0a12"
}
]
}
<value>
<dataframes>
<item>
<begin>2015-04-22T07:00:00</begin>
<end>2015-04-22T08:00:00</end>
<tenant_id>69d12143688f413cbf5c3cfe03ed0a12</tenant_id>
<resources>
<item>
<rating>1.0</rating>
<service>compute</service>
<desc>
<item>
<key>flavor</key>
<value>m1.tiny</value>
</item>
<item>
<key>vcpus</key>
<value>1</value>
</item>
</desc>
<volume>1.0</volume>
</item>
</resources>
</item>
</dataframes>
</value>
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.