Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> Service> Listing Services
View PDF

Listing Services

Function

This API is used to obtain the service list in a cluster.

URI

GET /api/v1/services

Table 1 describes the parameters of this API.

Table 1 Parameter description

Parameter

Mandatory

Description

pretty

No

If 'true', then the output is pretty printed.

labelSelector

No

A selector to restrict the list of returned objects by their labels. Defaults to everything.

fieldSelector

No

A selector to restrict the list of returned objects by their fields. Defaults to everything.

watch

No

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

resourceVersion

No

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

timeoutSeconds

No

Timeout for the list/watch call.

includeUninitialized

No

If true, partially initialized resources are included in the response.

Request

N/A

Response

Response parameters:

For the description about response parameters, see Table 2.

Example response:

{ 
   "kind": "ServiceList", 
   "apiVersion": "v1", 
   "metadata": { 
     "selfLink": "/api/v1/services", 
     "resourceVersion": "1244" 
   }, 
   "items": [ 
     { 
       "metadata": { 
         "name": "kubernetes", 
         "namespace": "default", 
         "selfLink": "/api/v1/namespaces/default/services/kubernetes", 
         "uid": "a50a2352-5d0b-11e6-aeb9-286ed488fafe", 
         "resourceVersion": "8", 
         "creationTimestamp": "2016-08-08T01:58:47Z", 
         "labels": { 
           "component": "apiserver", 
           "provider": "kubernetes" 
         } 
       }, 
       "spec": { 
         "ports": [ 
           { 
             "name": "https", 
             "protocol": "TCP", 
             "port": 443, 
             "targetPort": 443 
           } 
         ], 
         "clusterIP": "10.0.0.1", 
         "type": "ClusterIP", 
         "sessionAffinity": "None" 
       }, 
       "status": { 
         "loadBalancer": {} 
       } 
     }, 
     { 
       "metadata": { 
         "name": "myapp", 
         "namespace": "default", 
         "selfLink": "/api/v1/namespaces/default/services/myapp", 
         "uid": "58b5ca7c-5d12-11e6-aeb9-286ed488fafe", 
         "resourceVersion": "1204", 
         "creationTimestamp": "2016-08-08T02:46:46Z" 
       }, 
       "spec": { 
         "ports": [ 
           { 
             "protocol": "TCP", 
             "port": 80, 
             "targetPort": 80 
           } 
         ], 
         "selector": { 
           "app": "example" 
         }, 
         "clusterIP": "10.0.0.139", 
         "type": "ClusterIP", 
         "sessionAffinity": "None" 
       }, 
       "status": { 
         "loadBalancer": {} 
       } 
     } 
   ] 
 }

Status Code

Table 2 describes the status code of this API.

Table 2 Status code

Status Code

Description

200

This operation succeeds, and a group of Service resource objects is returned.

For the description about error status codes, see Status Code.

Parent topic: Service