RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
Version
Request:
http://<host>:<port>/info/version
Header:
Accept: application/json
OR
Accept: application/xmlResponse example
Example Response:
{
"projectName": "xconf-dataservice",
"projectVersion": "2.41.32-SNAPSHOT",
"serviceName": "N/A",
"serviceVersion": "N/A",
"source": "N/A",
"rev": "N/A",
"gitBranch": "N/A",
"gitBuildTime": "12/2/2016 1:22 PM",
"gitCommitId": "N/A",
"gitCommitTime": "N/A"
}
Config
Request:
http://<host>:<port>/info/config
Header:
Accept: application/json
OR
Accept: application/xmlResponse example
Example Response:
{
"domainClassesBasePackage": "com.comcast.xconf",
"validatorsBasePackage": "com.comcast.hydra.appdiscovery.validation",
"bindersBasePackage": "com.comcast.xconf.bindery",
"autoGenerateSchema": true,
"maxDataSizeForPut": null,
"keyspaces": {
"ApplicationsDiscoveryDataService": {
"name": "ApplicationsDiscoveryDataService",
"replicationFactor": 3
}
},
"columnFamiliesSchema": {},
"columnFamilies": {},
"connectionPools": {
"SharedConnectionPool": {
"name": "SharedConnectionPool",
"keyspaceName": "ApplicationsDiscoveryDataService",
"seeds": [
"localhost"
],
"maxConnsPerHost": 5,
"maxTimeoutWhenExhausted": 4000,
"socketTimeout": 15000,
"connectTimeout": 2000,
"timeoutWindow": 500,
"maxTimeoutCount": 10,
"maxFailoverCount": 2,
"useConnectionPoolMonitor": true,
"readConsistencyLevel": "CL_ONE",
"writeConsistencyLevel": "CL_ONE",
"discoveryDelayInSeconds": 60,
"autoDiscoverHosts": false,
"localDatacenter": "",
"nodeDiscoveryType": "NONE",
"connectionPoolType": "ROUND_ROBIN",
"maxOperationsPerConnection": 10000,
"retryPolicyType": "RUN_ONCE",
"maxAttemptCount": null,
"sleepTimeMs": null,
"maxSleepTimeMs": null,
"authKey": null,
"userId": null,
"password": null,
"authenticationCredentials": null
}
},
"endpoints": {
"defaults": {
"name": "defaults",
"maxResults": 300,
"maxObjectFieldSizeForGet": 0
}
},
"defaultCFConfiguration": {
"name": "defaults",
"keyspaceName": "ApplicationsDiscoveryDataService",
"connectionPoolName": "SharedConnectionPool",
"pageSize": 256,
"compactionStrategy": "SizeTieredCompactionStrategy",
"readRepairChance": 1,
"minCompactionThreshold": 4,
"maxCompactionThreshold": 32,
"replicateOnWrite": true,
"caching": "KEYS_ONLY"
},
"defaultConnectonPoolConfiguration": {
"name": "SharedConnectionPool",
"keyspaceName": "ApplicationsDiscoveryDataService",
"seeds": [
"localhost"
],
"maxConnsPerHost": 5,
"maxTimeoutWhenExhausted": 4000,
"socketTimeout": 15000,
"connectTimeout": 2000,
"timeoutWindow": 500,
"maxTimeoutCount": 10,
"maxFailoverCount": 2,
"useConnectionPoolMonitor": true,
"readConsistencyLevel": "CL_ONE",
"writeConsistencyLevel": "CL_ONE",
"discoveryDelayInSeconds": 60,
"autoDiscoverHosts": false,
"localDatacenter": "",
"nodeDiscoveryType": "NONE",
"connectionPoolType": "ROUND_ROBIN",
"maxOperationsPerConnection": 10000,
"retryPolicyType": "RUN_ONCE",
"maxAttemptCount": null,
"sleepTimeMs": null,
"maxSleepTimeMs": null,
"authKey": null,
"userId": null,
"password": null,
"authenticationCredentials": null
},
"cacheConfiguration": {
"retryCountUntilFullRefresh": 10,
"changedKeysTimeWindowSize": 900000,
"reloadCacheEntries": false,
"reloadCacheEntriesTimeout": 1,
"reloadCacheEntriesTimeUnit": "DAYS",
"numberOfEntriesToProcessSequentially": 10000,
"keysetChunkSizeForMassCacheLoad": 500,
"tickDuration": 60000
},
"specificConfig": {
"haProxyHeaderName": "HA-Forwarded-For",
"enableUpdateDeleteAPI": true
},
"defaultAccessControlPolicy": "RESTRICTIVE"
}
HeartBeat
Request: http://<host>:<port>/info/heartBeat Header: Accept: text/plain Example Response: Ok
Status
Request:
http://<host>:<port>/info/status
Header:
Accept: application/json
OR
Accept: application/xml
Example Response:
{
"badRequestCount": 0,
"uptime": 124,
"hostCount": 1,
"connectionCreateFailedCount": 0,
"operationFailureCount": 0,
"failoverCount": 0,
"operationSuccessCount": 17297,
"connectionCreatedCount": 5,
"connectionClosedCount": 0,
"connectionBorrowedCount": 17297,
"connectionReturnedCount": 17297,
"poolExhaustedTimeoutCount": 0,
"operationTimeoutCount": 0,
"socketTimeoutCount": 0,
"unknownErrorCount": 0,
"noHostCount": 0,
"interruptedCount": 0,
"transportErrorCount": 0,
"hostAddedCount": 1,
"hostRemovedCount": 0,
"hostDownCount": 0,
"hostActiveCount": 1,
"numBusyConnections": 0,
"numOpenConnections": 5
}
Statistics
Request:
http://<host>:<port>/info/statistics
Header:
Accept: application/json
OR
Accept: application/xml
Example Response:
{
"cacheMap": {
"FirmwareRule2": {
"daoRefreshTime": 0,
"totalLoadTime": 35160,
"requestCount": 384,
"evictionCount": 0,
"nonAbsentCount": 384,
"cacheSize": 384,
"hitRate": 0,
"missRate": 1
},
"SettingRules": {
"daoRefreshTime": 0,
"totalLoadTime": 387,
"requestCount": 1,
"evictionCount": 0,
"nonAbsentCount": 1,
"cacheSize": 1,
"hitRate": 0,
"missRate": 1
},
"Feature": {
"daoRefreshTime": 0,
"totalLoadTime": 132,
"requestCount": 10,
"evictionCount": 0,
"nonAbsentCount": 6,
"cacheSize": 10,
"hitRate": 0,
"missRate": 1
},
"TelemetryRules": {
"daoRefreshTime": 0,
"totalLoadTime": 90,
"requestCount": 5,
"evictionCount": 0,
"nonAbsentCount": 4,
"cacheSize": 5,
"hitRate": 0,
"missRate": 1
},
"Formula2": {
"daoRefreshTime": 0,
"totalLoadTime": 608,
"requestCount": 59,
"evictionCount": 0,
"nonAbsentCount": 59,
"cacheSize": 59,
"hitRate": 0,
"missRate": 1
},
"FeatureSet": {
"daoRefreshTime": 0,
"totalLoadTime": 17,
"requestCount": 4,
"evictionCount": 0,
"nonAbsentCount": 1,
"cacheSize": 4,
"hitRate": 0,
"missRate": 1
},
"FirmwareRuleTemplate": {
"daoRefreshTime": 0,
"totalLoadTime": 118,
"requestCount": 10,
"evictionCount": 0,
"nonAbsentCount": 9,
"cacheSize": 10,
"hitRate": 0,
"missRate": 1
},
"FirmwareConfig": {
"daoRefreshTime": 0,
"totalLoadTime": 15394,
"requestCount": 770,
"evictionCount": 0,
"nonAbsentCount": 287,
"cacheSize": 287,
"hitRate": 0.6272727272727273,
"missRate": 0.37272727272727274
},
"LogFile": {
"daoRefreshTime": 0,
"totalLoadTime": 112,
"requestCount": 25,
"evictionCount": 0,
"nonAbsentCount": 25,
"cacheSize": 25,
"hitRate": 0,
"missRate": 1
},
"DcmRule": {
"daoRefreshTime": 0,
"totalLoadTime": 564,
"requestCount": 65,
"evictionCount": 0,
"nonAbsentCount": 65,
"cacheSize": 65,
"hitRate": 0,
"missRate": 1
},
"Environment": {
"daoRefreshTime": 0,
"totalLoadTime": 35,
"requestCount": 5,
"evictionCount": 0,
"nonAbsentCount": 5,
"cacheSize": 5,
"hitRate": 0,
"missRate": 1
},
"DeviceSettings2": {
"daoRefreshTime": 0,
"totalLoadTime": 899,
"requestCount": 62,
"evictionCount": 0,
"nonAbsentCount": 62,
"cacheSize": 62,
"hitRate": 0,
"missRate": 1
},
"PermanentTelemetry": {
"daoRefreshTime": 0,
"totalLoadTime": 24,
"requestCount": 4,
"evictionCount": 0,
"nonAbsentCount": 4,
"cacheSize": 4,
"hitRate": 0,
"missRate": 1
},
"FeatureControlRule": {
"daoRefreshTime": 0,
"totalLoadTime": 22,
"requestCount": 2,
"evictionCount": 0,
"nonAbsentCount": 1,
"cacheSize": 2,
"hitRate": 0,
"missRate": 1
},
"UploadRepository": {
"daoRefreshTime": 0,
"totalLoadTime": 37,
"requestCount": 6,
"evictionCount": 0,
"nonAbsentCount": 6,
"cacheSize": 6,
"hitRate": 0,
"missRate": 1
},
"Model": {
"daoRefreshTime": 0,
"totalLoadTime": 373,
"requestCount": 33,
"evictionCount": 0,
"nonAbsentCount": 33,
"cacheSize": 33,
"hitRate": 0,
"missRate": 1
},
"IpAddressGroupExtended": {
"daoRefreshTime": 0,
"totalLoadTime": 312,
"requestCount": 40,
"evictionCount": 0,
"nonAbsentCount": 38,
"cacheSize": 40,
"hitRate": 0,
"missRate": 1
},
"VodSettings2": {
"daoRefreshTime": 0,
"totalLoadTime": 28,
"requestCount": 3,
"evictionCount": 0,
"nonAbsentCount": 3,
"cacheSize": 3,
"hitRate": 0,
"missRate": 1
},
"FilterAction": {
"daoRefreshTime": 0,
"totalLoadTime": 219,
"requestCount": 36,
"evictionCount": 0,
"nonAbsentCount": 36,
"cacheSize": 36,
"hitRate": 0,
"missRate": 1
},
"GenericXconfNamedList": {
"daoRefreshTime": 0,
"totalLoadTime": 6849,
"requestCount": 750,
"evictionCount": 0,
"nonAbsentCount": 177,
"cacheSize": 177,
"hitRate": 0.764,
"missRate": 0.236
},
"ConfigurationServiceURLs": {
"daoRefreshTime": 0,
"totalLoadTime": 0,
"requestCount": 0,
"evictionCount": 0,
"nonAbsentCount": 0,
"cacheSize": 0,
"hitRate": 1,
"missRate": 0
},
"LogUploadSettings2": {
"daoRefreshTime": 0,
"totalLoadTime": 870,
"requestCount": 65,
"evictionCount": 0,
"nonAbsentCount": 65,
"cacheSize": 65,
"hitRate": 0,
"missRate": 1
},
"FirmwareRule3": {
"daoRefreshTime": 0,
"totalLoadTime": 43910,
"requestCount": 391,
"evictionCount": 0,
"nonAbsentCount": 390,
"cacheSize": 391,
"hitRate": 0,
"missRate": 1
},
"XconfNamedList": {
"daoRefreshTime": 0,
"totalLoadTime": 23166,
"requestCount": 135,
"evictionCount": 0,
"nonAbsentCount": 135,
"cacheSize": 135,
"hitRate": 0,
"missRate": 1
},
"SingletonFilterValue": {
"daoRefreshTime": 0,
"totalLoadTime": 211,
"requestCount": 5,
"evictionCount": 0,
"nonAbsentCount": 2,
"cacheSize": 2,
"hitRate": 0.6,
"missRate": 0.4
},
"LogFileList": {
"daoRefreshTime": 0,
"totalLoadTime": 0,
"requestCount": 0,
"evictionCount": 0,
"nonAbsentCount": 0,
"cacheSize": 0,
"hitRate": 1,
"missRate": 0
},
"SettingProfiles": {
"daoRefreshTime": 0,
"totalLoadTime": 18,
"requestCount": 3,
"evictionCount": 0,
"nonAbsentCount": 3,
"cacheSize": 3,
"hitRate": 0,
"missRate": 1
},
"LogFilesGroups": {
"daoRefreshTime": 0,
"totalLoadTime": 0,
"requestCount": 0,
"evictionCount": 0,
"nonAbsentCount": 0,
"cacheSize": 0,
"hitRate": 1,
"missRate": 0
},
"Telemetry": {
"daoRefreshTime": 0,
"totalLoadTime": 0,
"requestCount": 0,
"evictionCount": 0,
"nonAbsentCount": 0,
"cacheSize": 0,
"hitRate": 1,
"missRate": 0
}
}
}
Refresh
Request:
http://<host>:<port>/info/refresh/{cfName} eg XconfNamedList
Header:
Accept: text/plain
Example Response:
OK
RefreshAll
Request: http://<host>:<port>/info/refreshAll Header: Accept: text/plain Example Response: Ok
Overview
Community Forums
Content Tools
Tasks
2 Comments
Unknown User (wittmanna)
Is there an openAPI / Swagger documentation available?
Ganesh Sahu
As of now it is not available, we will publish to community if case anything is added.