Skip to main content
Version: v1.10

ClusterResourceBinding v1alpha2

apiVersion: work.karmada.io/v1alpha2

import "github.com/karmada-io/karmada/pkg/apis/work/v1alpha2"

ClusterResourceBindingโ€‹

ClusterResourceBinding represents a binding of a kubernetes resource with a ClusterPropagationPolicy.


  • apiVersion: work.karmada.io/v1alpha2

  • kind: ClusterResourceBinding

  • metadata (ObjectMeta)

  • spec (ResourceBindingSpec), required

    Spec represents the desired behavior.

  • status (ResourceBindingStatus)

    Status represents the most recently observed status of the ResourceBinding.

ClusterResourceBindingListโ€‹

ClusterResourceBindingList contains a list of ClusterResourceBinding.


  • apiVersion: work.karmada.io/v1alpha2

  • kind: ClusterResourceBindingList

  • metadata (ListMeta)

  • items ([]ClusterResourceBinding), required

    Items is the list of ClusterResourceBinding.

Operationsโ€‹


get read the specified ClusterResourceBindingโ€‹

HTTP Requestโ€‹

GET /apis/work.karmada.io/v1alpha2/clusterresourcebindings/{name}

Parametersโ€‹

  • name (in path): string, required

    name of the ClusterResourceBinding

  • pretty (in query): string

    pretty

Responseโ€‹

200 (ClusterResourceBinding): OK

get read status of the specified ClusterResourceBindingโ€‹

HTTP Requestโ€‹

GET /apis/work.karmada.io/v1alpha2/clusterresourcebindings/{name}/status

Parametersโ€‹

  • name (in path): string, required

    name of the ClusterResourceBinding

  • pretty (in query): string

    pretty

Responseโ€‹

200 (ClusterResourceBinding): OK

list list or watch objects of kind ClusterResourceBindingโ€‹

HTTP Requestโ€‹

GET /apis/work.karmada.io/v1alpha2/clusterresourcebindings

Parametersโ€‹

Responseโ€‹

200 (ClusterResourceBindingList): OK

create create a ClusterResourceBindingโ€‹

HTTP Requestโ€‹

POST /apis/work.karmada.io/v1alpha2/clusterresourcebindings

Parametersโ€‹

Responseโ€‹

200 (ClusterResourceBinding): OK

201 (ClusterResourceBinding): Created

202 (ClusterResourceBinding): Accepted

update replace the specified ClusterResourceBindingโ€‹

HTTP Requestโ€‹

PUT /apis/work.karmada.io/v1alpha2/clusterresourcebindings/{name}

Parametersโ€‹

Responseโ€‹

200 (ClusterResourceBinding): OK

201 (ClusterResourceBinding): Created

update replace status of the specified ClusterResourceBindingโ€‹

HTTP Requestโ€‹

PUT /apis/work.karmada.io/v1alpha2/clusterresourcebindings/{name}/status

Parametersโ€‹

Responseโ€‹

200 (ClusterResourceBinding): OK

201 (ClusterResourceBinding): Created

patch partially update the specified ClusterResourceBindingโ€‹

HTTP Requestโ€‹

PATCH /apis/work.karmada.io/v1alpha2/clusterresourcebindings/{name}

Parametersโ€‹

  • name (in path): string, required

    name of the ClusterResourceBinding

  • body: Patch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • fieldValidation (in query): string

    fieldValidation

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

Responseโ€‹

200 (ClusterResourceBinding): OK

201 (ClusterResourceBinding): Created

patch partially update status of the specified ClusterResourceBindingโ€‹

HTTP Requestโ€‹

PATCH /apis/work.karmada.io/v1alpha2/clusterresourcebindings/{name}/status

Parametersโ€‹

  • name (in path): string, required

    name of the ClusterResourceBinding

  • body: Patch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • fieldValidation (in query): string

    fieldValidation

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

Responseโ€‹

200 (ClusterResourceBinding): OK

201 (ClusterResourceBinding): Created

delete delete a ClusterResourceBindingโ€‹

HTTP Requestโ€‹

DELETE /apis/work.karmada.io/v1alpha2/clusterresourcebindings/{name}

Parametersโ€‹

Responseโ€‹

200 (Status): OK

202 (Status): Accepted

deletecollection delete collection of ClusterResourceBindingโ€‹

HTTP Requestโ€‹

DELETE /apis/work.karmada.io/v1alpha2/clusterresourcebindings

Parametersโ€‹

Responseโ€‹

200 (Status): OK