更新TenantGateway

PUT

/v1/tenant/{tenant_id}/cluster/{cluster_id}/tenantgateways/{name}

Tenant

更新TenantGateway

请求参数

Path 参数

cluster_id

string

必需

cluster_id

tenant_id

string

tenant_id

必需

name

string

必需

Body 参数application/json

annotations

object

可选

Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: http://kubernetes.io/docs/user-guide/annotations
+optional

额外字段

string

可选

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
+optional

clusterName

string

可选

The name of the cluster which the object belongs to.
This is used to distinguish resources with same name and namespace in different clusters.
This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
+optional

creationTimestamp

string

可选

CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+optional

deletionGracePeriodSeconds

integer

可选

Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
+optional

deletionTimestamp

string

可选

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+optional

finalizers

array[string]

可选

Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
+optional
+patchStrategy=merge

generateName

string

可选

GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.

If this field is specified and the generated name exists, the server will
NOT return a 409 - instead, it will either return 201 Created or 500 with Reason
ServerTimeout indicating a unique name could not be found in the time allotted, and the client
should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
+optional

generation

integer

可选

A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
+optional

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
+optional

labels

object

可选

Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: http://kubernetes.io/docs/user-guide/labels
+optional

额外字段

string

可选

managedFields

array[object (v1.ManagedFieldsEntry) {7}]

可选

ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.

+optional

apiVersion

string

可选

APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.

fieldsType

string

可选

FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"

fieldsV1

object (v1.FieldsV1)

可选

manager

string

可选

Manager is an identifier of the workflow managing these fields.

operation

string

可选

Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.

subresource

string

可选

Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.

time

string

可选

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'
+optional

name

string

可选

Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: http://kubernetes.io/docs/user-guide/identifiers#names
+optional

namespace

string

可选

Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.

Must be a DNS_LABEL.
Cannot be updated.
More info: http://kubernetes.io/docs/user-guide/namespaces
+optional

ownerReferences

array[object (v1.OwnerReference) {6}]

可选

List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
+optional
+patchMergeKey=uid
+patchStrategy=merge

apiVersion

string

可选

API version of the referent.

blockOwnerDeletion

boolean

可选

If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
+optional

controller

boolean

可选

If true, this reference points to the managing controller.
+optional

kind

string

可选

Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

可选

Name of the referent.
More info: http://kubernetes.io/docs/user-guide/identifiers#names

uid

string

可选

UID of the referent.
More info: http://kubernetes.io/docs/user-guide/identifiers#uids

resourceVersion

string

可选

An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.

Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+optional

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.
+optional

spec

object (v1beta1.TenantGatewaySpec)

可选

baseDomain

string

可选

BaseDomain is a record to auto generate domain in ingress.
+kubebuilder:validation:Optional

configMapData

object

可选

Initial values of the Ingress Controller ConfigMap.
Check https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/ for
more information about possible values.
+kubebuilder:validation:Optional
+nullable

image

object (v1beta1.Image)

可选

ingressClass

string

可选

IngressClass 用以区分nginx作用域

replicas

integer

可选

Replicas 负载均衡实例数

service

object (v1beta1.Service)

可选

tenant

string

可选

Tenant 租户名

type

string

可选

Type 负载均衡类型

workload

object (v1beta1.Workload)

可选

status

object (v1beta1.TenantGatewayStatus)

可选

availableReplicas

integer

可选

ActAvailableReplicasive nginx deployment 正常的pod数

ports

array[object (v1.ServicePort) {6}]

可选

NodePort nginx service 占用的ports

uid

string

可选

UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.

Populated by the system.
Read-only.
More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+optional

示例

{
    "annotations": {
        "property1": "string",
        "property2": "string"
    },
    "apiVersion": "string",
    "clusterName": "string",
    "creationTimestamp": "string",
    "deletionGracePeriodSeconds": 0,
    "deletionTimestamp": "string",
    "finalizers": [
        "string"
    ],
    "generateName": "string",
    "generation": 0,
    "kind": "string",
    "labels": {
        "property1": "string",
        "property2": "string"
    },
    "managedFields": [
        {
            "apiVersion": "string",
            "fieldsType": "string",
            "fieldsV1": {},
            "manager": "string",
            "operation": "string",
            "subresource": "string",
            "time": "string"
        }
    ],
    "name": "string",
    "namespace": "string",
    "ownerReferences": [
        {
            "apiVersion": "string",
            "blockOwnerDeletion": true,
            "controller": true,
            "kind": "string",
            "name": "string",
            "uid": "string"
        }
    ],
    "resourceVersion": "string",
    "selfLink": "string",
    "spec": {
        "baseDomain": "string",
        "configMapData": {
            "property1": "string",
            "property2": "string"
        },
        "image": {
            "pullPolicy": "string",
            "repository": "string",
            "tag": "string"
        },
        "ingressClass": "string",
        "replicas": 0,
        "service": {
            "extraLabels": {
                "property1": "string",
                "property2": "string"
            }
        },
        "tenant": "string",
        "type": "string",
        "workload": {
            "extraLabels": {
                "property1": "string",
                "property2": "string"
            },
            "resources": {
                "limits": {
                    "property1": {
                        "Format": "string"
                    },
                    "property2": {
                        "Format": "string"
                    }
                },
                "requests": {
                    "property1": {
                        "Format": "string"
                    },
                    "property2": {
                        "Format": "string"
                    }
                }
            }
        }
    },
    "status": {
        "availableReplicas": 0,
        "ports": [
            {
                "appProtocol": "string",
                "name": "string",
                "nodePort": 0,
                "port": 0,
                "protocol": "string",
                "targetPort": {
                    "intVal": 0,
                    "strVal": "string",
                    "type": 0
                }
            }
        ]
    },
    "uid": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/v1/tenant//cluster//tenantgateways/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "annotations": {
        "property1": "string",
        "property2": "string"
    },
    "apiVersion": "string",
    "clusterName": "string",
    "creationTimestamp": "string",
    "deletionGracePeriodSeconds": 0,
    "deletionTimestamp": "string",
    "finalizers": [
        "string"
    ],
    "generateName": "string",
    "generation": 0,
    "kind": "string",
    "labels": {
        "property1": "string",
        "property2": "string"
    },
    "managedFields": [
        {
            "apiVersion": "string",
            "fieldsType": "string",
            "fieldsV1": {},
            "manager": "string",
            "operation": "string",
            "subresource": "string",
            "time": "string"
        }
    ],
    "name": "string",
    "namespace": "string",
    "ownerReferences": [
        {
            "apiVersion": "string",
            "blockOwnerDeletion": true,
            "controller": true,
            "kind": "string",
            "name": "string",
            "uid": "string"
        }
    ],
    "resourceVersion": "string",
    "selfLink": "string",
    "spec": {
        "baseDomain": "string",
        "configMapData": {
            "property1": "string",
            "property2": "string"
        },
        "image": {
            "pullPolicy": "string",
            "repository": "string",
            "tag": "string"
        },
        "ingressClass": "string",
        "replicas": 0,
        "service": {
            "extraLabels": {
                "property1": "string",
                "property2": "string"
            }
        },
        "tenant": "string",
        "type": "string",
        "workload": {
            "extraLabels": {
                "property1": "string",
                "property2": "string"
            },
            "resources": {
                "limits": {
                    "property1": {
                        "Format": "string"
                    },
                    "property2": {
                        "Format": "string"
                    }
                },
                "requests": {
                    "property1": {
                        "Format": "string"
                    },
                    "property2": {
                        "Format": "string"
                    }
                }
            }
        }
    },
    "status": {
        "availableReplicas": 0,
        "ports": [
            {
                "appProtocol": "string",
                "name": "string",
                "nodePort": 0,
                "port": 0,
                "protocol": "string",
                "targetPort": {
                    "intVal": 0,
                    "strVal": "string",
                    "type": 0
                }
            }
        ]
    },
    "uid": "string"
}'

返回响应

🟢200object

application/json

Body

data

可选

errorData

可选

message

string

可选

Data

object

v1beta1.TenantGateway

可选

annotations

object

可选

apiVersion

string

可选

clusterName

string

可选

creationTimestamp

string

可选

Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+optional

deletionGracePeriodSeconds

integer

可选

Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
+optional

deletionTimestamp

string

可选

Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+optional

finalizers

array[string]

可选

generateName

string

可选

Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
+optional

generation

integer

可选

A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
+optional

kind

string

可选

labels

object

可选

managedFields

array[object (v1.ManagedFieldsEntry) {7}]

可选

+optional

name

string

可选

namespace

string

可选

Must be a DNS_LABEL.
Cannot be updated.
More info: http://kubernetes.io/docs/user-guide/namespaces
+optional

ownerReferences

array[object (v1.OwnerReference) {6}]

可选

resourceVersion

string

可选

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.
+optional

spec

object

v1beta1.TenantGatewaySpec

可选

status

object

v1beta1.TenantGatewayStatus

可选

uid

string

可选

UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.

Populated by the system.
Read-only.
More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+optional

示例

{
    "data": null,
    "errorData": null,
    "message": "string",
    "Data": {
        "annotations": {
            "property1": "string",
            "property2": "string"
        },
        "apiVersion": "string",
        "clusterName": "string",
        "creationTimestamp": "string",
        "deletionGracePeriodSeconds": 0,
        "deletionTimestamp": "string",
        "finalizers": [
            "string"
        ],
        "generateName": "string",
        "generation": 0,
        "kind": "string",
        "labels": {
            "property1": "string",
            "property2": "string"
        },
        "managedFields": [
            {
                "apiVersion": "string",
                "fieldsType": "string",
                "fieldsV1": {},
                "manager": "string",
                "operation": "string",
                "subresource": "string",
                "time": "string"
            }
        ],
        "name": "string",
        "namespace": "string",
        "ownerReferences": [
            {
                "apiVersion": "string",
                "blockOwnerDeletion": true,
                "controller": true,
                "kind": "string",
                "name": "string",
                "uid": "string"
            }
        ],
        "resourceVersion": "string",
        "selfLink": "string",
        "spec": {
            "baseDomain": "string",
            "configMapData": {
                "property1": "string",
                "property2": "string"
            },
            "image": {
                "pullPolicy": "string",
                "repository": "string",
                "tag": "string"
            },
            "ingressClass": "string",
            "replicas": 0,
            "service": {
                "extraLabels": {
                    "property1": "string",
                    "property2": "string"
                }
            },
            "tenant": "string",
            "type": "string",
            "workload": {
                "extraLabels": {
                    "property1": "string",
                    "property2": "string"
                },
                "resources": {
                    "limits": {
                        "property1": {
                            "Format": "string"
                        },
                        "property2": {
                            "Format": "string"
                        }
                    },
                    "requests": {
                        "property1": {
                            "Format": "string"
                        },
                        "property2": {
                            "Format": "string"
                        }
                    }
                }
            }
        },
        "status": {
            "availableReplicas": 0,
            "ports": [
                {
                    "appProtocol": "string",
                    "name": "string",
                    "nodePort": 0,
                    "port": 0,
                    "protocol": "string",
                    "targetPort": {
                        "intVal": 0,
                        "strVal": "string",
                        "type": 0
                    }
                }
            ]
        },
        "uid": "string"
    }
}

获取TenantGateway

删除TenantGateway