Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> StatefulSet> Listing All StatefulSets
View PDF

Listing All StatefulSets

Function

This API is used to list specified StatefulSets.

URI

GET /apis/apps/v1/statefulsets (for clusters of v1.9 and later)

GET /apis/apps/v1beta1/statefulsets (for clusters of v1.15 and earlier)

Table 1 describes the parameters of this API.

Table 1 Description

Parameter

Mandatory

Description

fieldSelector

No

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

pretty

No

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

includeUninitialized

No

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

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.

watch

No

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

labelSelector

No

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

Request

N/A

Response

Response parameters:

Table 2 Response parameters

Parameter

Type

Description

kind

String

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated.

apiVersion

String

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

items

Object

List of StatefulSets. For details, see Table 2.

metadata

metadata object

Standard list metadata.
Table 3 Data structure of the metadata field

Parameter

Type

Description

resourceVersion

String

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only.

selfLink

String

SelfLink is a URL representing this object. Populated by the system. Read-only.

Example response:

{
    "kind": "StatefulSetList",
    "apiVersion": "apps/v1beta1",
    "metadata": {
        "selfLink": "/apis/apps/v1beta1/statefulsets",
        "resourceVersion": "1809953"
    },
    "items": [
        {
            "metadata": {
                "name": "mysql",
                "generateName": "sz",
                "namespace": "default",
                "selfLink": "/apis/apps/v1beta1/namespaces/default/statefulsets/mysql",
                "uid": "f5cf50f5-23fc-11e7-9c83-fa163ec08232",
                "resourceVersion": "1809843",
                "generation": 1,
                "creationTimestamp": "2017-04-18T06:05:02Z",
                "labels": {
                    "app": "mysql"
                }
            },
            "spec": {
                "replicas": 1,
                "selector": {
                    "matchLabels": {
                        "app": "mysql"
                    }
                },
                "template": {
                    "metadata": {
                        "name": "-sz",
                        "creationTimestamp": null,
                        "labels": {
                            "app": "mysql"
                        }
                    },
                    "spec": {
                        "containers": [
                            {
                                "name": "container01",
                                "image": "10.154.52.159:443/test/nginx:latest",
                                "ports": [
                                    {
                                        "containerPort": 80,
                                        "protocol": "TCP"
                                    }
                                ],
                                "resources": {},
                                "terminationMessagePath": "/dev/termination-log",
                                "imagePullPolicy": "IfNotPresent"
                            }
                        ],
                        "restartPolicy": "Always",
                        "terminationGracePeriodSeconds": 30,
                        "dnsPolicy": "ClusterFirst",
                        "securityContext": {}
                    }
                },
                "volumeClaimTemplates": [
                    {
                        "metadata": {
                            "name": "db",
                            "creationTimestamp": null
                        },
                        "spec": {
                            "accessModes": [
                                "ReadWriteOnce"
                            ],
                            "resources": {
                                "requests": {
                                    "storage": "1Gi"
                                }
                            }
                        },
                        "status": {
                            "phase": "Pending"
                        }
                    }
                ],
                "serviceName": "mysql-service"
            },
            "status": {
                "replicas": 1
            }
        }
    ]
}

Status Code

Table 4 describes the status code of this API.

Table 4 Status code

Status Code

Description

200

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

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

Parent topic: StatefulSet