/api/v1/namespaces/{namespace}/services

开发中

GET

core_v1

list or watch objects of kind Service

请求参数

Path 参数

namespace

string

必需

Query 参数

allowWatchBookmarks

string

可选

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue

string

可选

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

可选

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

labelSelector

string

可选

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

limit

integer

可选

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

可选

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

可选

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

可选

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

string

可选

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200OK

application/json

Body

ServiceList holds a list of services.

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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

array[object (io.k8s.api.core.v1.Service) {5}]

必需

List of services

apiVersion

string

可选

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. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

可选

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

spec

object (io.k8s.api.core.v1.ServiceSpec)

可选

ServiceSpec describes the attributes that a user creates on a service.

status

object (io.k8s.api.core.v1.ServiceStatus)

可选

ServiceStatus represents the current status of a service.

kind

string

可选

metadata

object (io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta)

可选

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

continue

string

可选

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

remainingItemCount

integer <int64>

可选

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

string

可选

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

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

示例

{
    "apiVersion": "string",
    "items": [
        {
            "apiVersion": "string",
            "kind": "string",
            "metadata": {
                "annotations": {
                    "property1": "string",
                    "property2": "string"
                },
                "clusterName": "string",
                "creationTimestamp": "2019-08-24T14:15:22Z",
                "deletionGracePeriodSeconds": 0,
                "deletionTimestamp": "2019-08-24T14:15:22Z",
                "finalizers": [
                    "string"
                ],
                "generateName": "string",
                "generation": 0,
                "labels": {
                    "property1": "string",
                    "property2": "string"
                },
                "managedFields": [
                    {
                        "apiVersion": "string",
                        "fieldsType": "string",
                        "fieldsV1": {},
                        "manager": "string",
                        "operation": "string",
                        "subresource": "string",
                        "time": "2019-08-24T14:15:22Z"
                    }
                ],
                "name": "string",
                "namespace": "string",
                "ownerReferences": [
                    {
                        "apiVersion": "string",
                        "blockOwnerDeletion": true,
                        "controller": true,
                        "kind": "string",
                        "name": "string",
                        "uid": "string"
                    }
                ],
                "resourceVersion": "string",
                "selfLink": "string",
                "uid": "string"
            },
            "spec": {
                "allocateLoadBalancerNodePorts": true,
                "clusterIP": "string",
                "clusterIPs": [
                    "string"
                ],
                "externalIPs": [
                    "string"
                ],
                "externalName": "string",
                "externalTrafficPolicy": "Cluster",
                "healthCheckNodePort": 0,
                "internalTrafficPolicy": "string",
                "ipFamilies": [
                    "string"
                ],
                "ipFamilyPolicy": "string",
                "loadBalancerClass": "string",
                "loadBalancerIP": "string",
                "loadBalancerSourceRanges": [
                    "string"
                ],
                "ports": [
                    {
                        "appProtocol": "string",
                        "name": "string",
                        "nodePort": 0,
                        "port": 0,
                        "protocol": "SCTP",
                        "targetPort": "string"
                    }
                ],
                "publishNotReadyAddresses": true,
                "selector": {
                    "property1": "string",
                    "property2": "string"
                },
                "sessionAffinity": "ClientIP",
                "sessionAffinityConfig": {
                    "clientIP": {
                        "timeoutSeconds": 0
                    }
                },
                "type": "ClusterIP"
            },
            "status": {
                "conditions": [
                    {
                        "lastTransitionTime": "2019-08-24T14:15:22Z",
                        "message": "string",
                        "observedGeneration": 0,
                        "reason": "string",
                        "status": "string",
                        "type": "string"
                    }
                ],
                "loadBalancer": {
                    "ingress": [
                        {
                            "hostname": "string",
                            "ip": "string",
                            "ports": [
                                {
                                    "error": "string",
                                    "port": 0,
                                    "protocol": "SCTP"
                                }
                            ]
                        }
                    ]
                }
            }
        }
    ],
    "kind": "string",
    "metadata": {
        "continue": "string",
        "remainingItemCount": 0,
        "resourceVersion": "string",
        "selfLink": "string"
    }
}

🟠401Unauthorized

/api/v1/namespaces/{namespace}/services