/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}

开发中

PUT

replace the specified CustomResourceDefinition

请求参数

Path 参数

name

string

必需

Query 参数

dryRun

string

可选

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

可选

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

fieldValidation

string

可选

fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the ServerSideFieldValidation feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/apis/apiextensions.k8s.io/v1/customresourcedefinitions/' \
--header 'Content-Type: text/plain' \
--data-raw ''

返回响应

🟢200OK

application/json

Body

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

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

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.

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

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.

creationTimestamp

string <date-time>

可选

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionGracePeriodSeconds

integer <int64>

可选

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.

deletionTimestamp

string <date-time>

可选

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

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.

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

generation

integer <int64>

可选

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

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

managedFields

array[object (io.k8s.apimachinery.pkg.apis.meta.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.

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

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

ownerReferences

array[object (io.k8s.apimachinery.pkg.apis.meta.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.

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

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.

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

spec

object (io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec)

必需

CustomResourceDefinitionSpec describes how a user wants their resource to appear

conversion

object (io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion)

可选

CustomResourceConversion describes how to convert different versions of a CR.

group

string

必需

group is the API group of the defined custom resource. The custom resources are served under /apis/<group>/.... Must match the name of the CustomResourceDefinition (in the form <names.plural>.<group>).

names

object (io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames)

必需

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

preserveUnknownFields

boolean

可选

preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting x-preserve-unknown-fields to true in spec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.

scope

string

必需

scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster and Namespaced.

versions

array[object (io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion) {8}]

必需

versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.

status

object (io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionStatus)

可选

CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

acceptedNames

object (io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames)

可选

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

conditions

array[object (io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionCondition) {5}]

可选

conditions indicate state for particular aspects of a CustomResourceDefinition

storedVersions

array[string]

可选

storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from spec.versions while they exist in this list.

示例

{
    "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": {
        "conversion": {
            "strategy": "string",
            "webhook": {
                "clientConfig": {
                    "caBundle": "string",
                    "service": {
                        "name": "string",
                        "namespace": "string",
                        "path": "string",
                        "port": 0
                    },
                    "url": "string"
                },
                "conversionReviewVersions": [
                    "string"
                ]
            }
        },
        "group": "string",
        "names": {
            "categories": [
                "string"
            ],
            "kind": "string",
            "listKind": "string",
            "plural": "string",
            "shortNames": [
                "string"
            ],
            "singular": "string"
        },
        "preserveUnknownFields": true,
        "scope": "string",
        "versions": [
            {
                "additionalPrinterColumns": [
                    {
                        "description": "string",
                        "format": "string",
                        "jsonPath": "string",
                        "name": "string",
                        "priority": 0,
                        "type": "string"
                    }
                ],
                "deprecated": true,
                "deprecationWarning": "string",
                "name": "string",
                "schema": {
                    "openAPIV3Schema": {
                        "$ref": "string",
                        "$schema": "string",
                        "additionalItems": null,
                        "additionalProperties": null,
                        "allOf": [
                            {}
                        ],
                        "anyOf": [
                            {}
                        ],
                        "default": null,
                        "definitions": {
                            "property1": {},
                            "property2": {}
                        },
                        "dependencies": {
                            "property1": null,
                            "property2": null
                        },
                        "description": "string",
                        "enum": [
                            null
                        ],
                        "example": null,
                        "exclusiveMaximum": true,
                        "exclusiveMinimum": true,
                        "externalDocs": {
                            "description": "string",
                            "url": "string"
                        },
                        "format": "string",
                        "id": "string",
                        "items": null,
                        "maxItems": 0,
                        "maxLength": 0,
                        "maxProperties": 0,
                        "maximum": 0,
                        "minItems": 0,
                        "minLength": 0,
                        "minProperties": 0,
                        "minimum": 0,
                        "multipleOf": 0,
                        "not": {},
                        "nullable": true,
                        "oneOf": [
                            {}
                        ],
                        "pattern": "string",
                        "patternProperties": {
                            "property1": {},
                            "property2": {}
                        },
                        "properties": {
                            "property1": {},
                            "property2": {}
                        },
                        "required": [
                            "string"
                        ],
                        "title": "string",
                        "type": "string",
                        "uniqueItems": true,
                        "x-kubernetes-embedded-resource": true,
                        "x-kubernetes-int-or-string": true,
                        "x-kubernetes-list-map-keys": [
                            "string"
                        ],
                        "x-kubernetes-list-type": "string",
                        "x-kubernetes-map-type": "string",
                        "x-kubernetes-preserve-unknown-fields": true,
                        "x-kubernetes-validations": [
                            {
                                "message": "string",
                                "rule": "string"
                            }
                        ]
                    }
                },
                "served": true,
                "storage": true,
                "subresources": {
                    "scale": {
                        "labelSelectorPath": "string",
                        "specReplicasPath": "string",
                        "statusReplicasPath": "string"
                    },
                    "status": {}
                }
            }
        ]
    },
    "status": {
        "acceptedNames": {
            "categories": [
                "string"
            ],
            "kind": "string",
            "listKind": "string",
            "plural": "string",
            "shortNames": [
                "string"
            ],
            "singular": "string"
        },
        "conditions": [
            {
                "lastTransitionTime": "2019-08-24T14:15:22Z",
                "message": "string",
                "reason": "string",
                "status": "string",
                "type": "string"
            }
        ],
        "storedVersions": [
            "string"
        ]
    }
}

🟢201Created

🟠401Unauthorized

修改于 2022-07-15 03:18:11

/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}

/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status