{"type":"api","title":"Get Service instances count","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/c1291a25-ce7e-325c-9659-0646f41e1a52","info":{"title":"cat-inventory-rpc","description":"This module defines service inventory RPC operations for retrieving services details from CNC.","termsOfService":"http://www.cisco.com/web/siteassets/legal/terms_condition.html","contact":{"name":"Cisco Systems","url":"https://www.cisco.com","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"tags":[{"name":"operations","description":"service inventory operations"}],"x-parser-conf":{"overview":{"markdownPath":"reference/CNC/cat-inventory-rpc-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cnc-host}:{cnc-port}/crosswork/nbi/cat-inventory/v1/restconf","variables":{"cnc-host":{"default":"127.0.0.1","description":"host name or ip address of the target CNC Cluster"},"cnc-port":{"default":"30603","description":"port number of the target CNC Cluster"}}}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"spec":{"tags":["operations","Since 1.0.0"],"summary":"Get Service instances count","description":"returns all service instances count including service instances\ncount per type that are currently known to the system at the time\nof request","operationId":"operations_cat_inventory_rpc_get_services_count_post","requestBody":{"description":"returns all service instances count including service instances\ncount per type that are currently known to the system at the time\nof request","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cat-inventory-rpc:input":{"type":"object","properties":{"cat-inventory-rpc:get-services-count-request":{"type":"object","properties":{"service-type":{"type":"string","description":"optinal. type of the service to which service instances count\n should be returned. if not provided, counts for all services and\n all service types will be returned. (leaf)","format":"string","x-yang":{"type":"leaf"}},"service-name-filters":{"type":"object","properties":{"start-with":{"type":"string","description":"start with pattern to apply for service-name match - example:\n for [foo-service, foo-bar-service] services, start-with=foo return\n both, start-with=foo-s return only foo-service (leaf)","format":"string","x-yang":{"type":"leaf"}},"case-sensitive":{"type":"string","description":"indicate if the filter value should be used for case sensitive\n filtering or not. if missing, it is considered as false (leaf)","format":"boolean","x-yang":{"type":"leaf"}}},"description":"filter to match the service-name to include services that match\nwith the pattern specified in the filter - default when this filter\nin not specified, no matching pattern is added on service name.\nWhen matching service name is not needed, it is recomended to\nommit this filter in the input as using this filter afffects query\nperformance. (non-presence)","x-yang":{"type":"container","is_presence":"false"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}}}}},"$$ref":"#/components/schemas/operations_cat-inventory-rpc_get-services-count-post-input"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cat-inventory-rpc:output":{"type":"object","properties":{"cat-inventory-rpc:get-services-count-response":{"type":"object","properties":{"total-services-count":{"type":"string","description":"total count of all service instances currently known to the system\n at the time of the request (leaf)","format":"int32","x-yang":{"type":"leaf"}},"services-count-per-type":{"type":"array","description":"(list)","items":{"type":"object","properties":{"service-type":{"type":"string","description":"type of the service (leaf)","format":"string","x-yang":{"type":"leaf"}},"count":{"type":"string","description":"service instances count per service type currently known to the\n system at the time of the request (leaf)","format":"int32","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"(non-presence)","x-yang":{"type":"container","is_presence":"false"}}}}},"$$ref":"#/components/schemas/operations_cat-inventory-rpc_get-services-count-post-output"}}}},"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request","content":{}},"401":{"description":"Unauthorized","content":{}},"404":{"description":"Not Found","content":{}},"405":{"description":"Method Not Allowed","content":{}},"409":{"description":"Conflict","content":{}}},"security":[{"bearerAuth":[]}],"x-codegen-request-body-name":"get-services-count","__originalOperationId":"operations_cat_inventory_rpc_get_services_count_post","method":"post","path":"/operations/cat-inventory-rpc:get-services-count"}}