你正在查看的文档所针对的是 Kubernetes 版本: v1.29
Kubernetes v1.29 版本的文档已不再维护。你现在看到的版本来自于一份静态的快照。如需查阅最新文档,请点击 最新版本。
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 (ObjectMeta)
标准的对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (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 必须引用一个父对象。
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 (ListMeta)
标准的对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]IPAddress),必需
items 是 IPAddresses 的列表。
操作
get
读取指定的 IPAddress
HTTP 请求
GET /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}
参数
name(路径参数):string,必需
IPAddress 的名称。
pretty(查询参数):string
响应
200 (IPAddress): OK
401: Unauthorized
list
列举或监视类别为 IPAddress 的对象
HTTP 请求
GET /apis/networking.k8s.io/v1alpha1/ipaddresses
参数
allowWatchBookmarks(查询参数):boolean
continue(查询参数):string
fieldSelector(查询参数):string
labelSelector(查询参数):string
limit(查询参数):integer
pretty(查询参数):string
resourceVersion(查询参数):string
resourceVersionMatch(查询参数):string
sendInitialEvents(查询参数):boolean
timeoutSeconds(查询参数):integer
watch(查询参数):boolean
响应
200 (IPAddressList): OK
401: Unauthorized
create
创建 IPAddress
HTTP 请求
POST /apis/networking.k8s.io/v1alpha1/ipaddresses
参数
body: IPAddress,必需
dryRun(查询参数):string
fieldManager(查询参数):string
fieldValidation(查询参数):string
pretty(查询参数):string
响应
200 (IPAddress): OK
201 (IPAddress): Created
202 (IPAddress): Accepted
401: Unauthorized
update
替换指定的 IPAddress
HTTP 请求
PUT /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}
参数
name(路径参数):string,必需
IPAddress 的名称。
body: IPAddress,必需
dryRun(查询参数):string
fieldManager(查询参数):string
fieldValidation(查询参数):string
pretty(查询参数):string
响应
200 (IPAddress): OK
201 (IPAddress): Created
401: Unauthorized
patch
部分更新指定的 IPAddress
HTTP 请求
PATCH /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}
参数
name(路径参数):string,必需
IPAddress 的名称。
body: Patch,必需
dryRun(查询参数):string
fieldManager(查询参数):string
fieldValidation(查询参数):string
force(查询参数):boolean
pretty(查询参数):string
响应
200 (IPAddress): OK
201 (IPAddress): Created
401: Unauthorized
delete
删除 IPAddress
HTTP 请求
DELETE /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}
参数
name(路径参数):string,必需
IPAddress 的名称。
body: DeleteOptions
dryRun(查询参数):string
gracePeriodSeconds(查询参数):integer
pretty(查询参数):string
propagationPolicy(查询参数):string
响应
200 (Status): OK
202 (Status): Accepted
401: Unauthorized
deletecollection
删除 IPAddress 的集合
HTTP 请求
DELETE /apis/networking.k8s.io/v1alpha1/ipaddresses
参数
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: Unauthorized