website/ip-address-v1alpha1.md at db31d7c34873d05f450dc8b51ef7a08e96ed369b

17 KiB

Raw Blame History

api_metadata

content_type

description

title

weight

apiVersion	import	kind
networking.k8s.io/v1alpha1	k8s.io/api/networking/v1alpha1	IPAddress

api_reference

IPAddress 表示单个 IP 族的单个 IP。

IPAddress v1alpha1

apiVersion: networking.k8s.io/v1alpha1

import "k8s.io/api/networking/v1alpha1"

IPAddress

IPAddress 表示单个 IP 族的单个 IP。此对象旨在供操作 IP 地址的 API 使用。此对象由 Service 核心 API 用于分配 IP 地址。 IP 地址可以用不同的格式表示，为了保证 IP 地址的唯一性，此对象的名称是格式规范的 IP 地址。 IPv4 地址由点分隔的四个十进制数字组成，前导零可省略；IPv6 地址按照 RFC 5952 的定义来表示。有效值：192.168.1.5、2001:db8::1 或 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1。无效值：10.01.2.3 或 2001:db8:0:0:0::1。

apiVersion: networking.k8s.io/v1alpha1
kind: IPAddress

metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta)

标准的对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddressSpec" >}}">IPAddressSpec)

spec 是 IPAddress 的预期状态。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

IPAddressSpec

IPAddressSpec 描述 IP 地址中的属性。

parentRef (ParentReference)

parentRef 引用挂接 IPAddress 的资源。IPAddress 必须引用一个父对象。

ParentReference 描述指向父对象的引用。
- parentRef.group (string)
  
  group 是被引用的对象的组。
- parentRef.name (string)
  
  name 是被引用的对象的名称。
- parentRef.namespace (string)
  
  namespace 是被引用的对象的名字空间。
- parentRef.resource (string)
  
  resource 是被引用的对象的资源。
- parentRef.uid (string)
  
  uid 是被引用的对象的唯一标识符（uid）。

IPAddressList

IPAddressList 包含 IPAddress 的列表。

apiVersion: networking.k8s.io/v1alpha1
kind: IPAddressList

metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)

标准的对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress)，必需

items 是 IPAddresses 的列表。

操作

`get` 读取指定的 IPAddress

HTTP 请求

GET /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}

参数

name（路径参数）：string，必需

IPAddress 的名称。
pretty（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress): OK

401: Unauthorized

`list` 列举或监视类别为 IPAddress 的对象

HTTP 请求

GET /apis/networking.k8s.io/v1alpha1/ipaddresses

参数

allowWatchBookmarks（查询参数）：boolean

<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
continue（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
fieldSelector（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
labelSelector（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
limit（查询参数）：integer

<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
pretty（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
resourceVersion（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
resourceVersionMatch（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
sendInitialEvents（查询参数）：boolean

<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents
timeoutSeconds（查询参数）：integer

<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
watch（查询参数）：boolean

<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

响应

200 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddressList" >}}">IPAddressList): OK

401: Unauthorized

`create` 创建 IPAddress

HTTP 请求

POST /apis/networking.k8s.io/v1alpha1/ipaddresses

参数

body: <a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress，必需
dryRun（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
fieldValidation（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
pretty（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress): OK

201 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress): Created

202 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress): Accepted

401: Unauthorized

`update` 替换指定的 IPAddress

HTTP 请求

PUT /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}

参数

name（路径参数）：string，必需

IPAddress 的名称。
body: <a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress，必需
dryRun（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
fieldValidation（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
pretty（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress): OK

201 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress): Created

401: Unauthorized

`patch` 部分更新指定的 IPAddress

HTTP 请求

PATCH /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}

参数

name（路径参数）：string，必需

IPAddress 的名称。
body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch，必需
dryRun（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
fieldValidation（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
force（查询参数）：boolean

<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force
pretty（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress): OK

201 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress): Created

401: Unauthorized

`delete` 删除 IPAddress

HTTP 请求

DELETE /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}

参数

name（路径参数）：string，必需

IPAddress 的名称。
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
dryRun（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
gracePeriodSeconds（查询参数）：integer

<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
pretty（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
propagationPolicy（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy

响应

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): Accepted

401: Unauthorized

`deletecollection` 删除 IPAddress 的集合

HTTP 请求

DELETE /apis/networking.k8s.io/v1alpha1/ipaddresses

参数

body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
continue（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
dryRun（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldSelector（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
gracePeriodSeconds（查询参数）：integer

<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
labelSelector（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
limit（查询参数）：integer

<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
pretty（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
propagationPolicy（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy
resourceVersion（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
resourceVersionMatch（查询参数）：string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
sendInitialEvents（查询参数）：boolean

<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents
timeoutSeconds（查询参数）：integer

<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

响应

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

401: Unauthorized

17 KiB Raw Blame History Unescape Escape

IPAddress

IPAddressSpec

IPAddressList

操作

get 读取指定的 IPAddress

HTTP 请求

参数

响应

list 列举或监视类别为 IPAddress 的对象

HTTP 请求

参数

响应

create 创建 IPAddress

HTTP 请求

参数

响应

update 替换指定的 IPAddress

HTTP 请求

参数

响应

patch 部分更新指定的 IPAddress

HTTP 请求

参数

响应

delete 删除 IPAddress

HTTP 请求

参数

响应

deletecollection 删除 IPAddress 的集合

HTTP 请求

参数

响应

17 KiB

Raw Blame History

`get` 读取指定的 IPAddress

`list` 列举或监视类别为 IPAddress 的对象

`create` 创建 IPAddress

`update` 替换指定的 IPAddress

`patch` 部分更新指定的 IPAddress

`delete` 删除 IPAddress

`deletecollection` 删除 IPAddress 的集合