服务
apiVersion: v1
import "k8s.io/api/core/v1"
服务
服务是软件服务的命名抽象（例如，mysql），它由代理监听的本地端口（例如 3306）和确定哪些 Pod 将响应通过代理发送的请求的选择器组成。
apiVersion: v1
kind: Service
metadata (ObjectMeta)
标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (ServiceSpec)
Spec 定义服务的行为。 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status (ServiceStatus)
服务的最新观察状态。由系统填充。只读。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
ServiceSpec
ServiceSpec 描述用户在服务上创建的属性。
selector (map[string]string)
将服务流量路由到标签键和值与该选择器匹配的 Pod。如果为空或不存在，则假定服务具有管理其端点的外部进程，Kubernetes 不会修改它。仅适用于类型 ClusterIP、NodePort 和 LoadBalancer。如果类型为 ExternalName，则忽略。更多信息：https://kubernetes.ac.cn/docs/concepts/services-networking/service/
ports ([]ServicePort)
补丁策略：按键
port合并映射：合并期间将保留键
port, protocol上的唯一值此服务公开的端口列表。更多信息：https://kubernetes.ac.cn/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
ports.port (int32), 必需
此服务将公开的端口。
ports.targetPort (IntOrString)
要访问服务目标 Pod 上的端口的数字或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。如果这是一个字符串，它将被视为目标 Pod 容器端口中的命名端口。如果未指定，则使用 'port' 字段的值（身份映射）。此字段对于 clusterIP=None 的服务被忽略，应省略或设置为等于 'port' 字段。更多信息：https://kubernetes.ac.cn/docs/concepts/services-networking/service/#defining-a-service
IntOrString 是一种可以保存 int32 或字符串的类型。在 JSON 或 YAML 序列化和反序列化时，它会生成或使用内部类型。这允许您拥有例如可以接受名称或数字的 JSON 字段。
ports.protocol (string)
此端口的 IP 协议。支持“TCP”、“UDP”和“SCTP”。默认值为 TCP。
ports.name (string)
此端口在服务中的名称。这必须是 DNS_LABEL。ServiceSpec 中的所有端口必须具有唯一的名称。在考虑服务的端点时，这必须与 EndpointPort 中的 'name' 字段匹配。如果此服务上只定义了一个 ServicePort，则可选。
ports.nodePort (int32)
当类型为 NodePort 或 LoadBalancer 时，此服务在每个节点上公开的端口。通常由系统分配。如果指定了值，在范围内且未使用，则将使用它，否则操作将失败。如果未指定，则如果此服务需要一个端口，则将分配一个端口。如果在创建不需要它的服务时指定了此字段，则创建将失败。当更新服务以不再需要它时（例如，将类型从 NodePort 更改为 ClusterIP），此字段将被清除。更多信息：https://kubernetes.ac.cn/docs/concepts/services-networking/service/#type-nodeport
ports.appProtocol (string)
此端口的应用程序协议。这用作实现的提示，以便为它们理解的协议提供更丰富的行为。此字段遵循标准 Kubernetes 标签语法。有效值为
无前缀协议名称 - 为 IANA 标准服务名称保留（根据 RFC-6335 和 https://www.iana.org/assignments/service-names).
Kubernetes 定义的前缀名称
- 'kubernetes.io/h2c' - HTTP/2 over cleartext，如 https://www.rfc-editor.org/rfc/rfc7540 中所述
- 'kubernetes.io/ws' - WebSocket over cleartext，如 https://www.rfc-editor.org/rfc/rfc6455 中所述
- 'kubernetes.io/wss' - WebSocket over TLS，如 https://www.rfc-editor.org/rfc/rfc6455 中所述
其他协议应使用实现定义的前缀名称，例如 mycompany.com/my-custom-protocol。
type (string)
type 决定如何公开服务。默认为 ClusterIP。有效选项为 ExternalName、ClusterIP、NodePort 和 LoadBalancer。“ClusterIP”为负载均衡到端点分配一个集群内部 IP 地址。端点由选择器确定，如果未指定，则由手动构建 Endpoints 对象或 EndpointSlice 对象确定。如果 clusterIP 为“None”，则不会分配虚拟 IP，并且端点将作为一组端点发布，而不是虚拟 IP。“NodePort”建立在 ClusterIP 之上，并在每个节点上分配一个端口，该端口路由到与 clusterIP 相同的端点。“LoadBalancer”建立在 NodePort 之上，并创建一个外部负载均衡器（如果当前云中支持），该负载均衡器路由到与 clusterIP 相同的端点。“ExternalName”将此服务别名为指定的 externalName。其他几个字段不适用于 ExternalName 服务。更多信息：https://kubernetes.ac.cn/docs/concepts/services-networking/service/#publishing-services-service-types
ipFamilies ([]string)
原子：在合并期间将被替换
IPFamilies 是分配给此服务的 IP 族列表（例如 IPv4、IPv6）。此字段通常根据集群配置和 ipFamilyPolicy 字段自动分配。如果手动指定此字段，并且请求的族在集群中可用，并且 ipFamilyPolicy 允许它，则将使用它；否则，服务的创建将失败。此字段是条件可变的：它允许添加或删除辅助 IP 族，但不允许更改服务的 primary IP 族。有效值为“IPv4”和“IPv6”。此字段仅适用于类型为 ClusterIP、NodePort 和 LoadBalancer 的服务，不适用于“无头”服务。当更新服务类型为 ExternalName 时，此字段将被清除。
此字段最多可以包含两个条目（双栈族，以任意顺序）。这些族必须与 clusterIPs 字段的值相对应（如果指定）。clusterIPs 和 ipFamilies 都受 ipFamilyPolicy 字段控制。
ipFamilyPolicy (string)
IPFamilyPolicy 表示此服务请求或需要的双栈性。如果没有提供值，则此字段将设置为 SingleStack。服务可以是“SingleStack”（单个 IP 族）、“PreferDualStack”（在双栈配置的集群上使用两个 IP 族，或在单栈配置的集群上使用单个 IP 族）或“RequireDualStack”（在双栈配置的集群上使用两个 IP 族，否则失败）。ipFamilies 和 clusterIPs 字段取决于此字段的值。当更新服务类型为 ExternalName 时，此字段将被清除。
clusterIP (string)
clusterIP 是服务的 IP 地址，通常是随机分配的。如果手动指定地址，在范围内（根据系统配置）且未使用，则将分配给服务；否则，服务的创建将失败。此字段可能无法通过更新更改，除非 type 字段也正在更改为 ExternalName（这需要此字段为空）或 type 字段正在从 ExternalName 更改（在这种情况下，此字段可以根据需要指定，如上所述）。有效值为“None”、“空字符串”（“”）或有效的 IP 地址。将其设置为“None”将创建一个“无头服务”（没有虚拟 IP），这在首选直接端点连接且不需要代理时很有用。仅适用于类型 ClusterIP、NodePort 和 LoadBalancer。如果在创建类型为 ExternalName 的服务时指定了此字段，则创建将失败。当更新服务类型为 ExternalName 时，此字段将被清除。更多信息：https://kubernetes.ac.cn/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
clusterIPs ([]string)
原子：在合并期间将被替换
ClusterIPs 是分配给此服务的 IP 地址列表，通常是随机分配的。如果手动指定地址，并且该地址在范围内（根据系统配置）且未被使用，则该地址将分配给该服务；否则，服务创建将失败。除非 type 字段也正在更改为 ExternalName（这需要该字段为空）或 type 字段正在从 ExternalName 更改（在这种情况下，该字段可以可选地指定，如上所述），否则无法通过更新更改此字段。有效值为“None”、空字符串（“”）或有效 IP 地址。将其设置为“None”将创建一个“无头服务”（没有虚拟 IP），这在需要直接端点连接且不需要代理时很有用。仅适用于 ClusterIP、NodePort 和 LoadBalancer 类型。如果在创建类型为 ExternalName 的服务时指定了此字段，则创建将失败。将服务更新为类型 ExternalName 时，此字段将被清除。如果未指定此字段，它将从 clusterIP 字段初始化。如果指定了此字段，客户端必须确保 clusterIPs[0] 和 clusterIP 具有相同的值。
此字段最多可以包含两个条目（双栈 IP，以任意顺序）。这些 IP 必须与 ipFamilies 字段的值相对应。clusterIPs 和 ipFamilies 都受 ipFamilyPolicy 字段控制。更多信息：https://kubernetes.ac.cn/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
externalIPs ([]string)
externalIPs 是一个 IP 地址列表，集群中的节点也将接受此服务的流量。这些 IP 不由 Kubernetes 管理。用户负责确保流量到达具有此 IP 的节点。一个常见的例子是外部负载均衡器，它们不是 Kubernetes 系统的一部分。
sessionAffinity (string)
支持“ClientIP”和“None”。用于维护会话亲和性。启用基于客户端 IP 的会话亲和性。必须是 ClientIP 或 None。默认为 None。更多信息：https://kubernetes.ac.cn/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
loadBalancerIP (string)
仅适用于服务类型：LoadBalancer。此功能取决于底层云提供商是否支持在创建负载均衡器时指定 loadBalancerIP。如果云提供商不支持此功能，则将忽略此字段。已弃用：此字段定义不足，其含义在不同的实现中有所不同。使用它不可移植，并且可能不支持双栈。鼓励用户在可用时使用特定于实现的注释。
loadBalancerSourceRanges ([]string)
如果指定并由平台支持，这将限制通过云提供商负载均衡器的流量，并将限制为指定的客户端 IP。如果云提供商不支持此功能，则将忽略此字段。“更多信息：https://kubernetes.ac.cn/docs/tasks/access-application-cluster/create-external-load-balancer/
loadBalancerClass (string)
loadBalancerClass 是此服务所属的负载均衡器实现的类别。如果指定，此字段的值必须是标签样式标识符，带有一个可选的前缀，例如“internal-vip”或“example.com/internal-vip”。未加前缀的名称保留给最终用户。此字段只能在服务类型为“LoadBalancer”时设置。如果未设置，则使用默认的负载均衡器实现，今天这通常通过云提供商集成完成，但应适用于任何默认实现。如果设置，则假定负载均衡器实现正在监视具有匹配类别的服务。任何默认的负载均衡器实现（例如云提供商）都应忽略设置此字段的服务。此字段只能在创建或更新服务为类型“LoadBalancer”时设置。一旦设置，就不能更改。将服务更新为非“LoadBalancer”类型时，此字段将被清除。
externalName (string)
externalName 是发现机制将返回作为此服务的别名的外部引用（例如 DNS CNAME 记录）。不会涉及任何代理。必须是符合 RFC-1123 的小写主机名（https://tools.ietf.org/html/rfc1123），并且需要
type为“ExternalName”。externalTrafficPolicy (string)
externalTrafficPolicy 描述了节点如何分配它们在服务的“面向外部”地址（NodePorts、ExternalIPs 和 LoadBalancer IP）之一上接收的服务流量。如果设置为“Local”，代理将以一种假设外部负载均衡器将负责在节点之间平衡服务流量的方式配置服务，因此每个节点只将流量传递到服务的节点本地端点，而不会伪造客户端源 IP。（错误地发送到没有端点的节点的流量将被丢弃。）默认值“Cluster”使用标准行为，即均匀地路由到所有端点（可能由拓扑和其他功能修改）。请注意，发送到外部 IP 或 LoadBalancer IP 的来自集群内部的流量始终会获得“Cluster”语义，但来自集群内部的发送到 NodePort 的客户端可能需要在选择节点时考虑流量策略。
internalTrafficPolicy (string)
InternalTrafficPolicy 描述了节点如何分配它们在 ClusterIP 上接收的服务流量。如果设置为“Local”，代理将假设 Pod 仅希望与同一节点上服务的端点通信，如果不存在本地端点，则丢弃流量。默认值“Cluster”使用标准行为，即均匀地路由到所有端点（可能由拓扑和其他功能修改）。
healthCheckNodePort (int32)
healthCheckNodePort 指定服务的健康检查 NodePort。这仅适用于 type 设置为 LoadBalancer 且 externalTrafficPolicy 设置为 Local 时。如果指定了值，并且该值在范围内且未被使用，则将使用该值。如果未指定，则将自动分配一个值。外部系统（例如负载均衡器）可以使用此端口来确定给定节点是否持有此服务的端点。如果在创建不需要此字段的服务时指定了此字段，则创建将失败。将服务更新为不再需要此字段（例如更改类型）时，此字段将被清除。设置后，此字段无法更新。
publishNotReadyAddresses (boolean)
publishNotReadyAddresses 指示处理此服务端点的任何代理应忽略任何关于就绪/未就绪的指示。设置此字段的主要用例是 StatefulSet 的无头服务，以传播其 Pod 的 SRV DNS 记录，用于对等发现。为服务生成端点和端点切片资源的 Kubernetes 控制器将此解释为意味着所有端点都被视为“就绪”，即使 Pod 本身未就绪也是如此。仅通过端点或端点切片资源使用 Kubernetes 生成的端点的代理可以安全地假设此行为。
sessionAffinityConfig (SessionAffinityConfig)
sessionAffinityConfig 包含会话亲和性的配置。
allocateLoadBalancerNodePorts (boolean)
allocateLoadBalancerNodePorts 定义是否为类型为 LoadBalancer 的服务自动分配 NodePorts。默认值为“true”。如果集群负载均衡器不依赖于 NodePorts，则可以将其设置为“false”。如果调用者请求特定的 NodePorts（通过指定一个值），则无论此字段如何，这些请求都将得到尊重。此字段只能为类型为 LoadBalancer 的服务设置，如果类型更改为任何其他类型，则将被清除。
ServiceStatus
ServiceStatus 表示服务的当前状态。
conditions ([]Condition)
补丁策略：按键
type合并映射：键类型上的唯一值将在合并期间保留
当前服务状态
Condition 包含有关此 API 资源当前状态的一个方面的详细信息。
conditions.lastTransitionTime (Time), required
lastTransitionTime 是条件从一种状态转换到另一种状态的最后时间。这应该是底层条件更改的时间。如果不知道，则使用 API 字段更改的时间是可以接受的。
Time 是 time.Time 的包装器，它支持正确地编组到 YAML 和 JSON。包装器为 time 包提供的许多工厂方法提供。
conditions.message (string), required
message 是一个人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。
conditions.reason (string), required
reason 包含一个程序化标识符，指示条件最后转换的原因。特定条件类型的生产者可以为该字段定义预期值和含义，以及这些值是否被视为保证的 API。该值应为驼峰式命名字符串。此字段不能为空。
conditions.status (string), required
条件的状态，为 True、False、Unknown 之一。
conditions.type (string), required
条件类型，以驼峰式命名或以 foo.example.com/CamelCase 命名。
conditions.observedGeneration (int64)
observedGeneration 表示设置条件的 .metadata.generation。例如，如果 .metadata.generation 当前为 12，但 .status.conditions[x].observedGeneration 为 9，则该条件相对于实例的当前状态已过时。
loadBalancer (LoadBalancerStatus)
LoadBalancer 包含负载均衡器的当前状态（如果存在）。
LoadBalancerStatus 表示负载均衡器的状态。
loadBalancer.ingress ([]LoadBalancerIngress)
Ingress 是一个列表，包含负载均衡器的入口点。发送到该服务的流量应发送到这些入口点。
LoadBalancerIngress 表示负载均衡器入口点的状态：发送到该服务的流量应发送到入口点。
loadBalancer.ingress.hostname (string)
Hostname 设置为基于 DNS 的负载均衡器入口点（通常是 AWS 负载均衡器）
loadBalancer.ingress.ip (string)
IP 设置为基于 IP 的负载均衡器入口点（通常是 GCE 或 OpenStack 负载均衡器）
loadBalancer.ingress.ipMode (string)
IPMode 指定负载均衡器 IP 的行为方式，并且只能在指定 ip 字段时指定。将其设置为“VIP”表示将流量传递到目标设置为负载均衡器 IP 和端口的节点。将其设置为“Proxy”表示将流量传递到目标设置为节点 IP 和节点端口或 Pod IP 和端口的节点或 Pod。服务实现可以使用此信息来调整流量路由。
loadBalancer.ingress.ports ([]PortStatus)
原子：在合并期间将被替换
Ports 是服务端口记录的列表，如果使用，服务中定义的每个端口都应该在其中有一个条目
loadBalancer.ingress.ports.port (int32), required
Port 是此处记录其状态的服务端口的端口号
loadBalancer.ingress.ports.protocol (string), required
Protocol 是此处记录其状态的服务端口的协议，支持的值为：“TCP”、“UDP”、“SCTP”
loadBalancer.ingress.ports.error (string)
Error 用于记录服务端口的问题，错误的格式应符合以下规则：- 内置错误值应在此文件中指定，并且应使用驼峰式命名
- 云提供商特定的错误值必须使用符合 foo.example.com/CamelCase 格式的名称。
ServiceList
ServiceList 包含服务列表。
apiVersion: v1
kind: ServiceList
metadata (ListMeta)
标准列表元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]Service), 必需
服务列表
操作
get 读取指定的服务
HTTP 请求
GET /api/v1/namespaces/{namespace}/services/{name}
参数
响应
200 (Service): OK
401: 未授权
get 读取指定服务的狀態
HTTP 请求
GET /api/v1/namespaces/{namespace}/services/{name}/status
参数
响应
200 (Service): OK
401: 未授权
list 列出或观察 Service 类型的对象
HTTP 请求
GET /api/v1/namespaces/{namespace}/services
参数
namespace (在路径中): string, 必需
allowWatchBookmarks (在查询中): boolean
continue (在查询中): string
fieldSelector (在查询中): string
labelSelector (在查询中): string
limit (在查询中): integer
pretty (在查询中): string
resourceVersion (在查询中): string
resourceVersionMatch (在查询中): string
sendInitialEvents (在查询中): boolean
timeoutSeconds (在查询中): integer
watch (在查询中): boolean
响应
200 (ServiceList): OK
401: 未授权
list 列出或观察 Service 类型的对象
HTTP 请求
GET /api/v1/services
参数
allowWatchBookmarks (在查询中): boolean
continue (在查询中): string
fieldSelector (在查询中): string
labelSelector (在查询中): string
limit (在查询中): integer
pretty (在查询中): string
resourceVersion (在查询中): string
resourceVersionMatch (在查询中): string
sendInitialEvents (在查询中): boolean
timeoutSeconds (在查询中): integer
watch (在查询中): boolean
响应
200 (ServiceList): OK
401: 未授权
create 创建一个服务
HTTP 请求
POST /api/v1/namespaces/{namespace}/services
参数
namespace (在路径中): string, 必需
body: Service, 必需
dryRun (在查询中): string
fieldManager (在查询中): string
fieldValidation (在查询中): string
pretty (在查询中): string
响应
200 (Service): OK
201 (Service): 已创建
202 (Service): 已接受
401: 未授权
update 替换指定的服务
HTTP 请求
PUT /api/v1/namespaces/{namespace}/services/{name}
参数
name (在路径中): string, 必需
服务的名称
namespace (在路径中): string, 必需
body: Service, 必需
dryRun (在查询中): string
fieldManager (在查询中): string
fieldValidation (在查询中): string
pretty (在查询中): string
响应
200 (Service): OK
201 (Service): 已创建
401: 未授权
update 替换指定服务的狀態
HTTP 请求
PUT /api/v1/namespaces/{namespace}/services/{name}/status
参数
name (在路径中): string, 必需
服务的名称
namespace (在路径中): string, 必需
body: Service, 必需
dryRun (在查询中): string
fieldManager (在查询中): string
fieldValidation (在查询中): string
pretty (在查询中): string
响应
200 (Service): OK
201 (Service): 已创建
401: 未授权
patch 部分更新指定的服务
HTTP 请求
PATCH /api/v1/namespaces/{namespace}/services/{name}
参数
name (在路径中): string, 必需
服务的名称
namespace (在路径中): string, 必需
body: Patch, 必需
dryRun (在查询中): string
fieldManager (在查询中): string
fieldValidation (在查询中): string
force (在查询中): boolean
pretty (在查询中): string
响应
200 (Service): OK
201 (Service): 已创建
401: 未授权
patch 部分更新指定服务的狀態
HTTP 请求
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
参数
name (在路径中): string, 必需
服务的名称
namespace (在路径中): string, 必需
body: Patch, 必需
dryRun (在查询中): string
fieldManager (在查询中): string
fieldValidation (在查询中): string
force (在查询中): boolean
pretty (在查询中): string
响应
200 (Service): OK
201 (Service): 已创建
401: 未授权
delete 删除一个服务
HTTP 请求
DELETE /api/v1/namespaces/{namespace}/services/{name}
参数
name (在路径中): string, 必需
服务的名称
namespace (在路径中): string, 必需
body: DeleteOptions
dryRun (在查询中): string
gracePeriodSeconds (在查询中): integer
pretty (在查询中): string
propagationPolicy (在查询中): string
响应
200 (Service): OK
202 (Service): 已接受
401: 未授权
deletecollection 删除 Service 集合
HTTP 请求
DELETE /api/v1/namespaces/{namespace}/services
参数
namespace (在路径中): string, 必需
body: DeleteOptions
continue (在查询中): string
dryRun (在查询中): string
fieldSelector (在查询中): string
gracePeriodSeconds (在查询中): integer
labelSelector (在查询中): string
limit (在查询中): integer
pretty (在查询中): string
propagationPolicy (在查询中): string
resourceVersion (在查询中): string
resourceVersionMatch (在查询中): string
sendInitialEvents (在查询中): boolean
timeoutSeconds (在查询中): integer
响应
200 (Status): OK
401: 未授权
此页面是自动生成的。
如果您打算报告此页面的问题，请在您的问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。