Gear6 MemcacheServer API Documentation

Fetch Memcached server statistics

Fetch a full set of statistics data for a particular memcached instance. "Category" should be one of: basic, health, replication, slabs, items, memory, storage.

Role:view

Method:GET

Url:/api/MemcacheServer/latest/#{instance}/stats/#{category}

Fetch server 'traffic' data

Fetch full set of stats data for a particular memcached instance. Data is returned in the form of an XML array.

Role:view

Method:GET

Url:/api/MemcacheServer/latest/#{instance}/stats/#{category}

Fetch top keys (appliance only)

Fetch top keys data for a memcached instance.

Role:view

Method:GET

Url:api/MemcacheServer/latest/#{instance}/stats/keys

Top Clients (appliance only)

Fetch top clients for a server.

Role:view

Method:GET

Url:api/MemcacheServer/latest/#{instance}/stats/clients

Top Clients for key (appliance only)

Fetch top clients for a particular key for a memcached instance.

Role:view

Method:GET

Url:api/MemcacheServer/latest/#{instance}/stats/clients/key/#{key64}

Stop reporting for an instance (appliance only)

Role:modify

Method:POST

Url:/api/MemcacheServer/latest/config/instance/#{ip}:#{port}/stop-reporting

Start reporting for an instance (appliance only)

Role:modify

Method:POST

Url:/api/MemcacheServer/latest/config/instance/#{ip}:#{port}/start-reporting

Load the UI config file

This is partly an aggregation of other files, so that the web UI only has to make a single call to fetch all of this data. It is not intended for general customer use.

Role:view

Method:GET

Url:/api/MemcacheServer/latest/config

<response>
				<result>OK</result>
				<data>
					<memcacheConfig time='2009-04-29 00:41:22' v='2'>
						<config>
						
							<div class='name'>Role:</div>
							<value>view</value>
						</config>
						<config>
						
							<div class='name'>mode</div>
							<value>cloud</value>
						</config>
						<config>
						
							<div class='name'>authorization</div>
							<value>disabled</value>
						</config>
						<config>
						
							<div class='name'>appname</div>
							<value>Cloud Cache</value>
						</config>
						<config>
						
							<div class='name'>serviceProvider</div>
							<value>Amazon EC2</value>
						</config>
						<config>
						
							<div class='name'>version</div>
							<value>2.3.7</value>
						</config>
						<config>
						
							<div class='name'>supportUrls</div>
							<value>
							{
								Support:'http://www.gear6.com/cloud-support-reg'
							}
							</value>
						</config>
						<config>
						
							<div class='name'>reporter</div>
							<value>on</value>
						</config>
						<config>
						
							<div class='name'>timezoneOffset</div>
							<value>0</value>
						</config>
						<config>
							
							<div class='name'>timezoneName</div>
							<value>GMT</value>
						</config>
						<config>
						
							<div class='name'>maxDataSamples</div>
							<value>500</value>
						</config>
						<config>
						
							<div class='name'>storageEnabled</div>
							<value>true</value>
						</config>
						<config>
						
							<div class='name'>replication</div>
							<value>off</value>
						</config>
						
					
						
						<service>
							
							<div class='name'>Foo</div>
					
							
							<status>enabled</status>
							
							 
							<package>memcached-gear6</package>
					
							
							<tcpPort>11211</tcpPort>
					
							
							<udpPort>11211</udpPort>
							
							
							<startDate>2009-12-01T01:23:45</startDate>
					
							
							<instance>
								
								<identifier>I-123456788</identifier>

<imageId>emi-91491395</imageId>

<arch>i386</arch>

<vendorType>m1.large</vendorType>
					
								
								<ip>10.3.6.236</ip>
					
								
								<port>11211</port>
					
								
								<status>running</status>
					
								
								<memcacheState>active</memcacheState>
					
								
								<reporterStatus>modify</reporterStatus>
					
								
								<reporterEnabled>true</reporterEnabled>
					
								
								<memory>800000000</memory>
					
								
								<used>300000000</used>
					
								
								<free>500000000</free>
					
								
								<rehashState>disabled</rehashState>
					
								
								<rehashPercent>57</rehashPercent>
					
								
								<config>
									<div class='name'>data_center</div>
									<value>data center description</value>
								</config>
								<config>
									<div class='name'>zone</div>
									<value>availability zone description</value>
								</config>
								
							</instance>
							
						</service>
					
						
						<service>
							<instance>
								<identifier>I-123456789</identifier>
								<imageId>emi-91491395</imageId>
								<arch>i386</arch>
								<vendorType>m1.large</vendorType>
								<ip>10.3.6.236</ip>
								<port>37981</port>
							</instance>
					  </service>
					</memcacheConfig>
				</data>
			</response>

Gear6 MemcacheServer API Documentation

Resources