CloudKitty REST API (v1)¶

Collector¶

type CollectorInfos¶

Type describing a collector module.

Data samples:

Json

{
    "enabled": true,
    "name": "ceilometer"
}

XML

b'<value>\n  <name>ceilometer</name>\n  <enabled>true</enabled>\n</value>'

enabled¶

Type:	bool

State of the collector.

name¶

Type:	str

Name of the collector.

type ServiceToCollectorMapping¶

Type describing a service to collector mapping.

Data samples:

Json

{
    "collector": "ceilometer",
    "service": "compute"
}

XML

b'<value>\n  <service>compute</service>\n  <collector>ceilometer</collector>\n</value>'

collector¶

Type:	str

Name of the collector.

service¶

Type:	str

Name of the service.

type ServiceToCollectorMappingCollection¶

Type describing a service to collector mapping collection.

Data samples:

Json

{
    "mappings": [
        {
            "collector": "ceilometer",
            "service": "compute"
        }
    ]
}

XML

b'<value>\n  <mappings>\n    <item>\n      <service>compute</service>\n      <collector>ceilometer</collector>\n    </item>\n  </mappings>\n</value>'

mappings¶

Type:	list(ServiceToCollectorMapping)

List of service to collector mappings.

Info¶

type CloudkittyServiceInfo¶

Type describing a service info in CloudKitty.

Data samples:

Json

{
    "metadata": [
        "resource_id",
        "flavor",
        "availability_zone"
    ],
    "service_id": "compute",
    "unit": "instance"
}

XML

b'<value>\n  <service_id>compute</service_id>\n  <metadata>\n    <item>resource_id</item>\n    <item>flavor</item>\n    <item>availability_zone</item>\n  </metadata>\n  <unit>instance</unit>\n</value>'

metadata¶

Type:	list(str)

List of service metadata

service_id¶

Type:	Enum(compute, volume, network.bw.in, network.bw.out, network.floating, image)

Name of the service.

unit¶

Type:	str

service unit

type CloudkittyServiceInfoCollection¶

A list of CloudKittyServiceInfo.

Data samples:

Json

{
    "services": [
        {
            "metadata": [
                "resource_id",
                "flavor",
                "availability_zone"
            ],
            "service_id": "compute",
            "unit": "instance"
        }
    ]
}

XML

b'<value>\n  <services>\n    <item>\n      <service_id>compute</service_id>\n      <metadata>\n        <item>resource_id</item>\n        <item>flavor</item>\n        <item>availability_zone</item>\n      </metadata>\n      <unit>instance</unit>\n    </item>\n  </services>\n</value>'

Rating¶

type CloudkittyModule¶

A rating extension summary

Data samples:

Json

{
    "description": "Sample extension.",
    "enabled": true,
    "hot-config": false,
    "priority": 2
}

XML

b'<value>\n  <description>Sample extension.</description>\n  <enabled>true</enabled>\n  <hot-config>false</hot-config>\n  <priority>2</priority>\n</value>'

description¶

Type:	str

Short description of the extension.

enabled¶

Type:	bool

Extension status.

hot_config¶

Type:	bool

On-the-fly configuration support.

module_id¶

Type:	str

Name of the extension.

priority¶

Type:	int

Priority of the extension.

type CloudkittyModuleCollection¶

A list of rating extensions.

Data samples:

Json

{}

XML

b'<value />'

type CloudkittyResource¶

Type describing a resource in CloudKitty.

Data samples:

Json

{
    "desc": {
        "image_id": "a41fba37-2429-4f15-aa00-b5bc4bf557bf"
    },
    "service": "compute",
    "volume": "1"
}

XML

b'<value>\n  <service>compute</service>\n  <desc>\n    <item>\n      <key>image_id</key>\n      <value>a41fba37-2429-4f15-aa00-b5bc4bf557bf</value>\n    </item>\n  </desc>\n  <volume>1</volume>\n</value>'

desc¶

Type:	dict(str: None)

Description of the resources parameters.

service¶

Type:	Enum(compute, volume, network.bw.in, network.bw.out, network.floating, image)

Name of the service.

volume¶

Type:	Decimal

Volume of resources.

type CloudkittyResourceCollection¶

A list of CloudKittyResources.

Data samples:

Json

{}

XML

b'<value />'

Report¶

Storage¶

type RatedResource¶

Represents a rated CloudKitty resource.

Data samples:

Json

{
    "desc": {
        "flavor": "m1.tiny",
        "vcpus": "1"
    },
    "rating": "1.0",
    "service": "compute",
    "volume": "1.0"
}

XML

b'<value>\n  <rating>1.0</rating>\n  <service>compute</service>\n  <desc>\n    <item>\n      <key>flavor</key>\n      <value>m1.tiny</value>\n    </item>\n    <item>\n      <key>vcpus</key>\n      <value>1</value>\n    </item>\n  </desc>\n  <volume>1.0</volume>\n</value>'

type DataFrame¶

Type describing a stored data frame.

Data samples:

Json

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

XML

b'<value>\n  <begin>2015-04-22T07:00:00</begin>\n  <end>2015-04-22T08:00:00</end>\n  <tenant_id>69d12143688f413cbf5c3cfe03ed0a12</tenant_id>\n  <resources>\n    <item>\n      <rating>1.0</rating>\n      <service>compute</service>\n      <desc>\n        <item>\n          <key>flavor</key>\n          <value>m1.tiny</value>\n        </item>\n        <item>\n          <key>vcpus</key>\n          <value>1</value>\n        </item>\n      </desc>\n      <volume>1.0</volume>\n    </item>\n  </resources>\n</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:	str

Tenant owner of the sample.

type DataFrameCollection¶

A list of stored data frames.

Data samples:

Json

{
    "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"
        }
    ]
}

XML

b'<value>\n  <dataframes>\n    <item>\n      <begin>2015-04-22T07:00:00</begin>\n      <end>2015-04-22T08:00:00</end>\n      <tenant_id>69d12143688f413cbf5c3cfe03ed0a12</tenant_id>\n      <resources>\n        <item>\n          <rating>1.0</rating>\n          <service>compute</service>\n          <desc>\n            <item>\n              <key>flavor</key>\n              <value>m1.tiny</value>\n            </item>\n            <item>\n              <key>vcpus</key>\n              <value>1</value>\n            </item>\n          </desc>\n          <volume>1.0</volume>\n        </item>\n      </resources>\n    </item>\n  </dataframes>\n</value>'