API Reference

API Reference - 图1

  • managementCattleIo_v3API Reference - 图2
    • getlistManagementCattleIoV3ClusterRoleTemplateBindingForAllNamespaces
    • getlistManagementCattleIoV3GlobalRoleBinding
    • postcreateManagementCattleIoV3GlobalRoleBinding
    • deldeleteManagementCattleIoV3CollectionGlobalRoleBinding
    • getreadManagementCattleIoV3GlobalRoleBinding
    • putreplaceManagementCattleIoV3GlobalRoleBinding
    • deldeleteManagementCattleIoV3GlobalRoleBinding
    • patchpatchManagementCattleIoV3GlobalRoleBinding
    • getlistManagementCattleIoV3GlobalRole
    • postcreateManagementCattleIoV3GlobalRole
    • deldeleteManagementCattleIoV3CollectionGlobalRole
    • getreadManagementCattleIoV3GlobalRole
    • putreplaceManagementCattleIoV3GlobalRole
    • deldeleteManagementCattleIoV3GlobalRole
    • patchpatchManagementCattleIoV3GlobalRole
    • getlistManagementCattleIoV3NamespacedClusterRoleTemplateBinding
    • postcreateManagementCattleIoV3NamespacedClusterRoleTemplateBinding
    • deldeleteManagementCattleIoV3CollectionNamespacedClusterRoleTemplateBinding
    • getreadManagementCattleIoV3NamespacedClusterRoleTemplateBinding
    • putreplaceManagementCattleIoV3NamespacedClusterRoleTemplateBinding
    • deldeleteManagementCattleIoV3NamespacedClusterRoleTemplateBinding
    • patchpatchManagementCattleIoV3NamespacedClusterRoleTemplateBinding
    • getlistManagementCattleIoV3NamespacedProjectRoleTemplateBinding
    • postcreateManagementCattleIoV3NamespacedProjectRoleTemplateBinding
    • deldeleteManagementCattleIoV3CollectionNamespacedProjectRoleTemplateBinding
    • getreadManagementCattleIoV3NamespacedProjectRoleTemplateBinding
    • putreplaceManagementCattleIoV3NamespacedProjectRoleTemplateBinding
    • deldeleteManagementCattleIoV3NamespacedProjectRoleTemplateBinding
    • patchpatchManagementCattleIoV3NamespacedProjectRoleTemplateBinding
    • getlistManagementCattleIoV3NamespacedProject
    • postcreateManagementCattleIoV3NamespacedProject
    • deldeleteManagementCattleIoV3CollectionNamespacedProject
    • getreadManagementCattleIoV3NamespacedProject
    • putreplaceManagementCattleIoV3NamespacedProject
    • deldeleteManagementCattleIoV3NamespacedProject
    • patchpatchManagementCattleIoV3NamespacedProject
    • getlistManagementCattleIoV3ProjectRoleTemplateBindingForAllNamespaces
    • getlistManagementCattleIoV3ProjectForAllNamespaces
    • getlistManagementCattleIoV3RoleTemplate
    • postcreateManagementCattleIoV3RoleTemplate
    • deldeleteManagementCattleIoV3CollectionRoleTemplate
    • getreadManagementCattleIoV3RoleTemplate
    • putreplaceManagementCattleIoV3RoleTemplate
    • deldeleteManagementCattleIoV3RoleTemplate
    • patchpatchManagementCattleIoV3RoleTemplate

API docs by Redocly

API Reference - 图3API Reference - 图4

Kubernetes (v1.27.5+k3s1)

Download OpenAPI specification:Download

managementCattleIo_v3

listManagementCattleIoV3ClusterRoleTemplateBindingForAllNamespaces

list objects of kind ClusterRoleTemplateBinding

Authorizations:

API Reference - 图5

BearerToken

query Parameters
allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

pretty
string unique

If ‘true’, then the output is pretty printed.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图6200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/clusterroletemplatebindingsAPI Reference - 图7

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/clusterroletemplatebindings

Response samples

  • 200

Content type

API Reference - 图8application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “items”: [

    • {

      • “apiVersion”: “string”,

      • “clusterName”: “string”,

      • “groupName”: “string”,

      • “groupPrincipalName”: “string”,

      • “kind”: “string”,

      • “metadata”: {

        • “annotations”: {

          • “property1”: “string”,

          • “property2”: “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”

        },

      • “roleTemplateName”: “string”,

      • “userName”: “string”,

      • “userPrincipalName”: “string”

      }

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    }

}`

listManagementCattleIoV3GlobalRoleBinding

list objects of kind GlobalRoleBinding

Authorizations:

API Reference - 图9

BearerToken

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图10200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/globalrolebindingsAPI Reference - 图11

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalrolebindings

Response samples

  • 200

Content type

API Reference - 图12application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “items”: [

    • {

      • “apiVersion”: “string”,

      • “globalRoleName”: “string”,

      • “groupPrincipalName”: “string”,

      • “kind”: “string”,

      • “metadata”: {

        • “annotations”: {

          • “property1”: “string”,

          • “property2”: “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”

        },

      • “userName”: “string”

      }

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    }

}`

createManagementCattleIoV3GlobalRoleBinding

create a GlobalRoleBinding

Authorizations:

API Reference - 图13

BearerToken

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图14application/jsonapplication/yamlapplication/json

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

globalRoleName
required
string

GlobalRoleName is the name of the Global Role that the subject will be bound to. Immutable.

groupPrincipalName
string

GroupPrincipalName is the name of the group principal subject to be bound. Immutable.

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

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.

userName
string

UserName is the name of the user subject to be bound. Immutable.

Responses

API Reference - 图16200

OK

API Reference - 图17201

Created

API Reference - 图18202

Accepted

401

Unauthorized

post/apis/management.cattle.io/v3/globalrolebindingsAPI Reference - 图19

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalrolebindings

Request samples

  • Payload

Content type

API Reference - 图20application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “globalRoleName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “userName”: “string”

}`

Response samples

  • 200
  • 201
  • 202

Content type

API Reference - 图21application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “globalRoleName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “userName”: “string”

}`

deleteManagementCattleIoV3CollectionGlobalRoleBinding

delete collection of GlobalRoleBinding

Authorizations:

API Reference - 图22

BearerToken

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图23200

OK

401

Unauthorized

delete/apis/management.cattle.io/v3/globalrolebindingsAPI Reference - 图24

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalrolebindings

Response samples

  • 200

Content type

API Reference - 图25application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

readManagementCattleIoV3GlobalRoleBinding

read the specified GlobalRoleBinding

Authorizations:

API Reference - 图26

BearerToken

path Parameters
name
required
string unique

name of the GlobalRoleBinding

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

Responses

API Reference - 图27200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/globalrolebindings/{name}API Reference - 图28

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalrolebindings/{name}

Response samples

  • 200

Content type

API Reference - 图29application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “globalRoleName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “userName”: “string”

}`

replaceManagementCattleIoV3GlobalRoleBinding

replace the specified GlobalRoleBinding

Authorizations:

API Reference - 图30

BearerToken

path Parameters
name
required
string unique

name of the GlobalRoleBinding

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图31application/jsonapplication/yamlapplication/json

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

globalRoleName
required
string

GlobalRoleName is the name of the Global Role that the subject will be bound to. Immutable.

groupPrincipalName
string

GroupPrincipalName is the name of the group principal subject to be bound. Immutable.

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

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.

userName
string

UserName is the name of the user subject to be bound. Immutable.

Responses

API Reference - 图33200

OK

API Reference - 图34201

Created

401

Unauthorized

put/apis/management.cattle.io/v3/globalrolebindings/{name}API Reference - 图35

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalrolebindings/{name}

Request samples

  • Payload

Content type

API Reference - 图36application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “globalRoleName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “userName”: “string”

}`

Response samples

  • 200
  • 201

Content type

API Reference - 图37application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “globalRoleName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “userName”: “string”

}`

deleteManagementCattleIoV3GlobalRoleBinding

delete a GlobalRoleBinding

Authorizations:

API Reference - 图38

BearerToken

path Parameters
name
required
string unique

name of the GlobalRoleBinding

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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

gracePeriodSeconds
integer unique

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents
boolean unique

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy
string unique

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Request Body schema:

API Reference - 图39application/jsonapplication/yamlapplication/json

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

dryRun
Array of strings

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

gracePeriodSeconds
integer <int64>

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

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

orphanDependents
boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

object (io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions)

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

propagationPolicy
string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Responses

API Reference - 图41200

OK

API Reference - 图42202

Accepted

401

Unauthorized

delete/apis/management.cattle.io/v3/globalrolebindings/{name}API Reference - 图43

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalrolebindings/{name}

Request samples

  • Payload

Content type

API Reference - 图44application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “dryRun”: [

    • “string”

    ],

  • “gracePeriodSeconds”: 0,

  • “kind”: “string”,

  • “orphanDependents”: true,

  • “preconditions”: {

    • “resourceVersion”: “string”,

    • “uid”: “string”

    },

  • “propagationPolicy”: “string”

}`

Response samples

  • 200
  • 202

Content type

API Reference - 图45application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

patchManagementCattleIoV3GlobalRoleBinding

partially update the specified GlobalRoleBinding

Authorizations:

API Reference - 图46

BearerToken

path Parameters
name
required
string unique

name of the GlobalRoleBinding

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

fieldValidation
string unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

force
boolean unique

Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Request Body schema:

API Reference - 图47application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

object (io.k8s.apimachinery.pkg.apis.meta.v1.Patch)

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Responses

API Reference - 图48200

OK

401

Unauthorized

patch/apis/management.cattle.io/v3/globalrolebindings/{name}API Reference - 图49

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalrolebindings/{name}

Request samples

  • Payload

Content type

API Reference - 图50application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

Copy

{ }

Response samples

  • 200

Content type

API Reference - 图51application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “globalRoleName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “userName”: “string”

}`

listManagementCattleIoV3GlobalRole

list objects of kind GlobalRole

Authorizations:

API Reference - 图52

BearerToken

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图53200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/globalrolesAPI Reference - 图54

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalroles

Response samples

  • 200

Content type

API Reference - 图55application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “items”: [

    • {

      • “apiVersion”: “string”,

      • “builtin”: true,

      • “description”: “string”,

      • “displayName”: “string”,

      • “inheritedClusterRoles”: [

        • “string”

        ],

      • “kind”: “string”,

      • “metadata”: {

        • “annotations”: {

          • “property1”: “string”,

          • “property2”: “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”

        },

      • “newUserDefault”: true,

      • “rules”: [

        • {

          • “apiGroups”: [

            • “string”

            ],

          • “nonResourceURLs”: [

            • “string”

            ],

          • “resourceNames”: [

            • “string”

            ],

          • “resources”: [

            • “string”

            ],

          • “verbs”: [

            • “string”

            ]

          }

        ]

      }

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    }

}`

createManagementCattleIoV3GlobalRole

create a GlobalRole

Authorizations:

API Reference - 图56

BearerToken

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图57application/jsonapplication/yamlapplication/json

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

builtin
boolean

Builtin specifies that this GlobalRole was created by Rancher if true. Immutable.

description
string

Description holds text that describes the resource.

displayName
string

DisplayName is the human-readable name displayed in the UI for this resource.

inheritedClusterRoles
Array of strings

InheritedClusterRoles are the names of RoleTemplates whose permissions are granted by this GlobalRole in every cluster besides the local cluster. To grant permissions in the local cluster, use the Rules field.

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

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.

newUserDefault
boolean

NewUserDefault specifies that all new users created should be bound to this GlobalRole if true.

Array of objects

Rules holds a list of PolicyRules that are applied to the local cluster only.

Responses

API Reference - 图60200

OK

API Reference - 图61201

Created

API Reference - 图62202

Accepted

401

Unauthorized

post/apis/management.cattle.io/v3/globalrolesAPI Reference - 图63

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalroles

Request samples

  • Payload

Content type

API Reference - 图64application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “description”: “string”,

  • “displayName”: “string”,

  • “inheritedClusterRoles”: [

    • “string”

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “newUserDefault”: true,

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

Response samples

  • 200
  • 201
  • 202

Content type

API Reference - 图65application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “description”: “string”,

  • “displayName”: “string”,

  • “inheritedClusterRoles”: [

    • “string”

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “newUserDefault”: true,

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

deleteManagementCattleIoV3CollectionGlobalRole

delete collection of GlobalRole

Authorizations:

API Reference - 图66

BearerToken

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图67200

OK

401

Unauthorized

delete/apis/management.cattle.io/v3/globalrolesAPI Reference - 图68

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalroles

Response samples

  • 200

Content type

API Reference - 图69application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

readManagementCattleIoV3GlobalRole

read the specified GlobalRole

Authorizations:

API Reference - 图70

BearerToken

path Parameters
name
required
string unique

name of the GlobalRole

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

Responses

API Reference - 图71200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/globalroles/{name}API Reference - 图72

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalroles/{name}

Response samples

  • 200

Content type

API Reference - 图73application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “description”: “string”,

  • “displayName”: “string”,

  • “inheritedClusterRoles”: [

    • “string”

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “newUserDefault”: true,

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

replaceManagementCattleIoV3GlobalRole

replace the specified GlobalRole

Authorizations:

API Reference - 图74

BearerToken

path Parameters
name
required
string unique

name of the GlobalRole

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图75application/jsonapplication/yamlapplication/json

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

builtin
boolean

Builtin specifies that this GlobalRole was created by Rancher if true. Immutable.

description
string

Description holds text that describes the resource.

displayName
string

DisplayName is the human-readable name displayed in the UI for this resource.

inheritedClusterRoles
Array of strings

InheritedClusterRoles are the names of RoleTemplates whose permissions are granted by this GlobalRole in every cluster besides the local cluster. To grant permissions in the local cluster, use the Rules field.

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

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.

newUserDefault
boolean

NewUserDefault specifies that all new users created should be bound to this GlobalRole if true.

Array of objects

Rules holds a list of PolicyRules that are applied to the local cluster only.

Responses

API Reference - 图78200

OK

API Reference - 图79201

Created

401

Unauthorized

put/apis/management.cattle.io/v3/globalroles/{name}API Reference - 图80

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalroles/{name}

Request samples

  • Payload

Content type

API Reference - 图81application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “description”: “string”,

  • “displayName”: “string”,

  • “inheritedClusterRoles”: [

    • “string”

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “newUserDefault”: true,

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

Response samples

  • 200
  • 201

Content type

API Reference - 图82application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “description”: “string”,

  • “displayName”: “string”,

  • “inheritedClusterRoles”: [

    • “string”

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “newUserDefault”: true,

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

deleteManagementCattleIoV3GlobalRole

delete a GlobalRole

Authorizations:

API Reference - 图83

BearerToken

path Parameters
name
required
string unique

name of the GlobalRole

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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

gracePeriodSeconds
integer unique

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents
boolean unique

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy
string unique

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Request Body schema:

API Reference - 图84application/jsonapplication/yamlapplication/json

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

dryRun
Array of strings

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

gracePeriodSeconds
integer <int64>

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

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

orphanDependents
boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

object (io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions)

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

propagationPolicy
string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Responses

API Reference - 图86200

OK

API Reference - 图87202

Accepted

401

Unauthorized

delete/apis/management.cattle.io/v3/globalroles/{name}API Reference - 图88

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalroles/{name}

Request samples

  • Payload

Content type

API Reference - 图89application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “dryRun”: [

    • “string”

    ],

  • “gracePeriodSeconds”: 0,

  • “kind”: “string”,

  • “orphanDependents”: true,

  • “preconditions”: {

    • “resourceVersion”: “string”,

    • “uid”: “string”

    },

  • “propagationPolicy”: “string”

}`

Response samples

  • 200
  • 202

Content type

API Reference - 图90application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

patchManagementCattleIoV3GlobalRole

partially update the specified GlobalRole

Authorizations:

API Reference - 图91

BearerToken

path Parameters
name
required
string unique

name of the GlobalRole

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

fieldValidation
string unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

force
boolean unique

Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Request Body schema:

API Reference - 图92application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

object (io.k8s.apimachinery.pkg.apis.meta.v1.Patch)

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Responses

API Reference - 图93200

OK

401

Unauthorized

patch/apis/management.cattle.io/v3/globalroles/{name}API Reference - 图94

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/globalroles/{name}

Request samples

  • Payload

Content type

API Reference - 图95application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

Copy

{ }

Response samples

  • 200

Content type

API Reference - 图96application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “description”: “string”,

  • “displayName”: “string”,

  • “inheritedClusterRoles”: [

    • “string”

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “newUserDefault”: true,

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

listManagementCattleIoV3NamespacedClusterRoleTemplateBinding

list objects of kind ClusterRoleTemplateBinding

Authorizations:

API Reference - 图97

BearerToken

path Parameters
namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图98200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindingsAPI Reference - 图99

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings

Response samples

  • 200

Content type

API Reference - 图100application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “items”: [

    • {

      • “apiVersion”: “string”,

      • “clusterName”: “string”,

      • “groupName”: “string”,

      • “groupPrincipalName”: “string”,

      • “kind”: “string”,

      • “metadata”: {

        • “annotations”: {

          • “property1”: “string”,

          • “property2”: “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”

        },

      • “roleTemplateName”: “string”,

      • “userName”: “string”,

      • “userPrincipalName”: “string”

      }

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    }

}`

createManagementCattleIoV3NamespacedClusterRoleTemplateBinding

create a ClusterRoleTemplateBinding

Authorizations:

API Reference - 图101

BearerToken

path Parameters
namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图102application/jsonapplication/yamlapplication/json

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

clusterName
required
string

ClusterName is the metadata.name of the cluster to which a subject is added. Must match the namespace. Immutable.

groupName
string

GroupName is the name of the group subject added to the cluster. Immutable.

groupPrincipalName
string

GroupPrincipalName is the name of the group principal subject added to the cluster. Immutable.

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

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.

roleTemplateName
required
string

RoleTemplateName is the name of the role template that defines permissions to perform actions on resources in the cluster. Immutable.

userName
string

UserName is the name of the user subject added to the cluster. Immutable.

userPrincipalName
string

UserPrincipalName is the name of the user principal subject added to the cluster. Immutable.

Responses

API Reference - 图104200

OK

API Reference - 图105201

Created

API Reference - 图106202

Accepted

401

Unauthorized

post/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindingsAPI Reference - 图107

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings

Request samples

  • Payload

Content type

API Reference - 图108application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “clusterName”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “roleTemplateName”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

Response samples

  • 200
  • 201
  • 202

Content type

API Reference - 图109application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “clusterName”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “roleTemplateName”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

deleteManagementCattleIoV3CollectionNamespacedClusterRoleTemplateBinding

delete collection of ClusterRoleTemplateBinding

Authorizations:

API Reference - 图110

BearerToken

path Parameters
namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图111200

OK

401

Unauthorized

delete/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindingsAPI Reference - 图112

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings

Response samples

  • 200

Content type

API Reference - 图113application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

readManagementCattleIoV3NamespacedClusterRoleTemplateBinding

read the specified ClusterRoleTemplateBinding

Authorizations:

API Reference - 图114

BearerToken

path Parameters
name
required
string unique

name of the ClusterRoleTemplateBinding

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

Responses

API Reference - 图115200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings/{name}API Reference - 图116

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings/{name}

Response samples

  • 200

Content type

API Reference - 图117application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “clusterName”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “roleTemplateName”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

replaceManagementCattleIoV3NamespacedClusterRoleTemplateBinding

replace the specified ClusterRoleTemplateBinding

Authorizations:

API Reference - 图118

BearerToken

path Parameters
name
required
string unique

name of the ClusterRoleTemplateBinding

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图119application/jsonapplication/yamlapplication/json

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

clusterName
required
string

ClusterName is the metadata.name of the cluster to which a subject is added. Must match the namespace. Immutable.

groupName
string

GroupName is the name of the group subject added to the cluster. Immutable.

groupPrincipalName
string

GroupPrincipalName is the name of the group principal subject added to the cluster. Immutable.

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

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.

roleTemplateName
required
string

RoleTemplateName is the name of the role template that defines permissions to perform actions on resources in the cluster. Immutable.

userName
string

UserName is the name of the user subject added to the cluster. Immutable.

userPrincipalName
string

UserPrincipalName is the name of the user principal subject added to the cluster. Immutable.

Responses

API Reference - 图121200

OK

API Reference - 图122201

Created

401

Unauthorized

put/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings/{name}API Reference - 图123

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings/{name}

Request samples

  • Payload

Content type

API Reference - 图124application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “clusterName”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “roleTemplateName”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

Response samples

  • 200
  • 201

Content type

API Reference - 图125application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “clusterName”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “roleTemplateName”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

deleteManagementCattleIoV3NamespacedClusterRoleTemplateBinding

delete a ClusterRoleTemplateBinding

Authorizations:

API Reference - 图126

BearerToken

path Parameters
name
required
string unique

name of the ClusterRoleTemplateBinding

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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

gracePeriodSeconds
integer unique

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents
boolean unique

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy
string unique

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Request Body schema:

API Reference - 图127application/jsonapplication/yamlapplication/json

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

dryRun
Array of strings

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

gracePeriodSeconds
integer <int64>

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

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

orphanDependents
boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

object (io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions)

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

propagationPolicy
string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Responses

API Reference - 图129200

OK

API Reference - 图130202

Accepted

401

Unauthorized

delete/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings/{name}API Reference - 图131

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings/{name}

Request samples

  • Payload

Content type

API Reference - 图132application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “dryRun”: [

    • “string”

    ],

  • “gracePeriodSeconds”: 0,

  • “kind”: “string”,

  • “orphanDependents”: true,

  • “preconditions”: {

    • “resourceVersion”: “string”,

    • “uid”: “string”

    },

  • “propagationPolicy”: “string”

}`

Response samples

  • 200
  • 202

Content type

API Reference - 图133application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

patchManagementCattleIoV3NamespacedClusterRoleTemplateBinding

partially update the specified ClusterRoleTemplateBinding

Authorizations:

API Reference - 图134

BearerToken

path Parameters
name
required
string unique

name of the ClusterRoleTemplateBinding

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

fieldValidation
string unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

force
boolean unique

Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Request Body schema:

API Reference - 图135application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

object (io.k8s.apimachinery.pkg.apis.meta.v1.Patch)

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Responses

API Reference - 图136200

OK

401

Unauthorized

patch/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings/{name}API Reference - 图137

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/clusterroletemplatebindings/{name}

Request samples

  • Payload

Content type

API Reference - 图138application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

Copy

{ }

Response samples

  • 200

Content type

API Reference - 图139application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “clusterName”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “roleTemplateName”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

listManagementCattleIoV3NamespacedProjectRoleTemplateBinding

list objects of kind ProjectRoleTemplateBinding

Authorizations:

API Reference - 图140

BearerToken

path Parameters
namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图141200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindingsAPI Reference - 图142

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings

Response samples

  • 200

Content type

API Reference - 图143application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “items”: [

    • {

      • “apiVersion”: “string”,

      • “groupName”: “string”,

      • “groupPrincipalName”: “string”,

      • “kind”: “string”,

      • “metadata”: {

        • “annotations”: {

          • “property1”: “string”,

          • “property2”: “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”

        },

      • “projectName”: “string”,

      • “roleTemplateName”: “string”,

      • “serviceAccount”: “string”,

      • “userName”: “string”,

      • “userPrincipalName”: “string”

      }

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    }

}`

createManagementCattleIoV3NamespacedProjectRoleTemplateBinding

create a ProjectRoleTemplateBinding

Authorizations:

API Reference - 图144

BearerToken

path Parameters
namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图145application/jsonapplication/yamlapplication/json

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

groupName
string

GroupName is the name of the group subject added to the project. Immutable.

groupPrincipalName
string

GroupPrincipalName is the name of the group principal subject added to the project. Immutable.

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

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.

projectName
required
string

ProjectName is the name of the project to which a subject is added. Immutable.

roleTemplateName
required
string

RoleTemplateName is the name of the role template that defines permissions to perform actions on resources in the project. Immutable.

serviceAccount
string

ServiceAccount is the name of the service account bound as a subject. Immutable. Deprecated.

userName
string

UserName is the name of the user subject added to the project. Immutable.

userPrincipalName
string

UserPrincipalName is the name of the user principal subject added to the project. Immutable.

Responses

API Reference - 图147200

OK

API Reference - 图148201

Created

API Reference - 图149202

Accepted

401

Unauthorized

post/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindingsAPI Reference - 图150

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings

Request samples

  • Payload

Content type

API Reference - 图151application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectName”: “string”,

  • “roleTemplateName”: “string”,

  • “serviceAccount”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

Response samples

  • 200
  • 201
  • 202

Content type

API Reference - 图152application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectName”: “string”,

  • “roleTemplateName”: “string”,

  • “serviceAccount”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

deleteManagementCattleIoV3CollectionNamespacedProjectRoleTemplateBinding

delete collection of ProjectRoleTemplateBinding

Authorizations:

API Reference - 图153

BearerToken

path Parameters
namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图154200

OK

401

Unauthorized

delete/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindingsAPI Reference - 图155

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings

Response samples

  • 200

Content type

API Reference - 图156application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

readManagementCattleIoV3NamespacedProjectRoleTemplateBinding

read the specified ProjectRoleTemplateBinding

Authorizations:

API Reference - 图157

BearerToken

path Parameters
name
required
string unique

name of the ProjectRoleTemplateBinding

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

Responses

API Reference - 图158200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings/{name}API Reference - 图159

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings/{name}

Response samples

  • 200

Content type

API Reference - 图160application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectName”: “string”,

  • “roleTemplateName”: “string”,

  • “serviceAccount”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

replaceManagementCattleIoV3NamespacedProjectRoleTemplateBinding

replace the specified ProjectRoleTemplateBinding

Authorizations:

API Reference - 图161

BearerToken

path Parameters
name
required
string unique

name of the ProjectRoleTemplateBinding

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图162application/jsonapplication/yamlapplication/json

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

groupName
string

GroupName is the name of the group subject added to the project. Immutable.

groupPrincipalName
string

GroupPrincipalName is the name of the group principal subject added to the project. Immutable.

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

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.

projectName
required
string

ProjectName is the name of the project to which a subject is added. Immutable.

roleTemplateName
required
string

RoleTemplateName is the name of the role template that defines permissions to perform actions on resources in the project. Immutable.

serviceAccount
string

ServiceAccount is the name of the service account bound as a subject. Immutable. Deprecated.

userName
string

UserName is the name of the user subject added to the project. Immutable.

userPrincipalName
string

UserPrincipalName is the name of the user principal subject added to the project. Immutable.

Responses

API Reference - 图164200

OK

API Reference - 图165201

Created

401

Unauthorized

put/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings/{name}API Reference - 图166

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings/{name}

Request samples

  • Payload

Content type

API Reference - 图167application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectName”: “string”,

  • “roleTemplateName”: “string”,

  • “serviceAccount”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

Response samples

  • 200
  • 201

Content type

API Reference - 图168application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectName”: “string”,

  • “roleTemplateName”: “string”,

  • “serviceAccount”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

deleteManagementCattleIoV3NamespacedProjectRoleTemplateBinding

delete a ProjectRoleTemplateBinding

Authorizations:

API Reference - 图169

BearerToken

path Parameters
name
required
string unique

name of the ProjectRoleTemplateBinding

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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

gracePeriodSeconds
integer unique

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents
boolean unique

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy
string unique

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Request Body schema:

API Reference - 图170application/jsonapplication/yamlapplication/json

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

dryRun
Array of strings

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

gracePeriodSeconds
integer <int64>

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

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

orphanDependents
boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

object (io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions)

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

propagationPolicy
string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Responses

API Reference - 图172200

OK

API Reference - 图173202

Accepted

401

Unauthorized

delete/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings/{name}API Reference - 图174

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings/{name}

Request samples

  • Payload

Content type

API Reference - 图175application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “dryRun”: [

    • “string”

    ],

  • “gracePeriodSeconds”: 0,

  • “kind”: “string”,

  • “orphanDependents”: true,

  • “preconditions”: {

    • “resourceVersion”: “string”,

    • “uid”: “string”

    },

  • “propagationPolicy”: “string”

}`

Response samples

  • 200
  • 202

Content type

API Reference - 图176application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

patchManagementCattleIoV3NamespacedProjectRoleTemplateBinding

partially update the specified ProjectRoleTemplateBinding

Authorizations:

API Reference - 图177

BearerToken

path Parameters
name
required
string unique

name of the ProjectRoleTemplateBinding

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

fieldValidation
string unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

force
boolean unique

Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Request Body schema:

API Reference - 图178application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

object (io.k8s.apimachinery.pkg.apis.meta.v1.Patch)

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Responses

API Reference - 图179200

OK

401

Unauthorized

patch/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings/{name}API Reference - 图180

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projectroletemplatebindings/{name}

Request samples

  • Payload

Content type

API Reference - 图181application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

Copy

{ }

Response samples

  • 200

Content type

API Reference - 图182application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “groupName”: “string”,

  • “groupPrincipalName”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectName”: “string”,

  • “roleTemplateName”: “string”,

  • “serviceAccount”: “string”,

  • “userName”: “string”,

  • “userPrincipalName”: “string”

}`

listManagementCattleIoV3NamespacedProject

list objects of kind Project

Authorizations:

API Reference - 图183

BearerToken

path Parameters
namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图184200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/namespaces/{namespace}/projectsAPI Reference - 图185

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projects

Response samples

  • 200

Content type

API Reference - 图186application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “items”: [

    • {

      • “apiVersion”: “string”,

      • “kind”: “string”,

      • “metadata”: {

        • “annotations”: {

          • “property1”: “string”,

          • “property2”: “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”: {

        • “clusterName”: “string”,

        • “containerDefaultResourceLimit”: {

          • “limitsCpu”: “string”,

          • “limitsMemory”: “string”,

          • “requestsCpu”: “string”,

          • “requestsMemory”: “string”

          },

        • “description”: “string”,

        • “displayName”: “string”,

        • “enableProjectMonitoring”: true,

        • “namespaceDefaultResourceQuota”: {

          • “limit”: {

            • “configMaps”: “string”,

            • “limitsCpu”: “string”,

            • “limitsMemory”: “string”,

            • “persistentVolumeClaims”: “string”,

            • “pods”: “string”,

            • “replicationControllers”: “string”,

            • “requestsCpu”: “string”,

            • “requestsMemory”: “string”,

            • “requestsStorage”: “string”,

            • “secrets”: “string”,

            • “services”: “string”,

            • “servicesLoadBalancers”: “string”,

            • “servicesNodePorts”: “string”

            }

          },

        • “resourceQuota”: {

          • “limit”: {

            • “configMaps”: “string”,

            • “limitsCpu”: “string”,

            • “limitsMemory”: “string”,

            • “persistentVolumeClaims”: “string”,

            • “pods”: “string”,

            • “replicationControllers”: “string”,

            • “requestsCpu”: “string”,

            • “requestsMemory”: “string”,

            • “requestsStorage”: “string”,

            • “secrets”: “string”,

            • “services”: “string”,

            • “servicesLoadBalancers”: “string”,

            • “servicesNodePorts”: “string”

            },

          • “usedLimit”: {

            • “configMaps”: “string”,

            • “limitsCpu”: “string”,

            • “limitsMemory”: “string”,

            • “persistentVolumeClaims”: “string”,

            • “pods”: “string”,

            • “replicationControllers”: “string”,

            • “requestsCpu”: “string”,

            • “requestsMemory”: “string”,

            • “requestsStorage”: “string”,

            • “secrets”: “string”,

            • “services”: “string”,

            • “servicesLoadBalancers”: “string”,

            • “servicesNodePorts”: “string”

            }

          }

        },

      • “status”: {

        • “conditions”: [

          • {

            • “lastTransitionTime”: “string”,

            • “lastUpdateTime”: “string”,

            • “message”: “string”,

            • “reason”: “string”,

            • “status”: “string”,

            • “type”: “string”

            }

          ],

        • “monitoringStatus”: {

          • “conditions”: [

            • {

              • “lastTransitionTime”: “string”,

              • “lastUpdateTime”: “string”,

              • “message”: “string”,

              • “reason”: “string”,

              • “status”: “string”,

              • “type”: “string”

              }

            ],

          • “grafanaEndpoint”: “string”

          },

        • “podSecurityPolicyTemplateId”: “string”

        }

      }

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    }

}`

createManagementCattleIoV3NamespacedProject

create a Project

Authorizations:

API Reference - 图187

BearerToken

path Parameters
namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图188application/jsonapplication/yamlapplication/json

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

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.

object

Spec is the specification of the desired configuration for the project.

object

Status is the most recently observed status of the project.

Responses

API Reference - 图192200

OK

API Reference - 图193201

Created

API Reference - 图194202

Accepted

401

Unauthorized

post/apis/management.cattle.io/v3/namespaces/{namespace}/projectsAPI Reference - 图195

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projects

Request samples

  • Payload

Content type

API Reference - 图196application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”: {

    • “clusterName”: “string”,

    • “containerDefaultResourceLimit”: {

      • “limitsCpu”: “string”,

      • “limitsMemory”: “string”,

      • “requestsCpu”: “string”,

      • “requestsMemory”: “string”

      },

    • “description”: “string”,

    • “displayName”: “string”,

    • “enableProjectMonitoring”: true,

    • “namespaceDefaultResourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      },

    • “resourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        },

      • “usedLimit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      }

    },

  • “status”: {

    • “conditions”: [

      • {

        • “lastTransitionTime”: “string”,

        • “lastUpdateTime”: “string”,

        • “message”: “string”,

        • “reason”: “string”,

        • “status”: “string”,

        • “type”: “string”

        }

      ],

    • “monitoringStatus”: {

      • “conditions”: [

        • {

          • “lastTransitionTime”: “string”,

          • “lastUpdateTime”: “string”,

          • “message”: “string”,

          • “reason”: “string”,

          • “status”: “string”,

          • “type”: “string”

          }

        ],

      • “grafanaEndpoint”: “string”

      },

    • “podSecurityPolicyTemplateId”: “string”

    }

}`

Response samples

  • 200
  • 201
  • 202

Content type

API Reference - 图197application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”: {

    • “clusterName”: “string”,

    • “containerDefaultResourceLimit”: {

      • “limitsCpu”: “string”,

      • “limitsMemory”: “string”,

      • “requestsCpu”: “string”,

      • “requestsMemory”: “string”

      },

    • “description”: “string”,

    • “displayName”: “string”,

    • “enableProjectMonitoring”: true,

    • “namespaceDefaultResourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      },

    • “resourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        },

      • “usedLimit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      }

    },

  • “status”: {

    • “conditions”: [

      • {

        • “lastTransitionTime”: “string”,

        • “lastUpdateTime”: “string”,

        • “message”: “string”,

        • “reason”: “string”,

        • “status”: “string”,

        • “type”: “string”

        }

      ],

    • “monitoringStatus”: {

      • “conditions”: [

        • {

          • “lastTransitionTime”: “string”,

          • “lastUpdateTime”: “string”,

          • “message”: “string”,

          • “reason”: “string”,

          • “status”: “string”,

          • “type”: “string”

          }

        ],

      • “grafanaEndpoint”: “string”

      },

    • “podSecurityPolicyTemplateId”: “string”

    }

}`

deleteManagementCattleIoV3CollectionNamespacedProject

delete collection of Project

Authorizations:

API Reference - 图198

BearerToken

path Parameters
namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图199200

OK

401

Unauthorized

delete/apis/management.cattle.io/v3/namespaces/{namespace}/projectsAPI Reference - 图200

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projects

Response samples

  • 200

Content type

API Reference - 图201application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

readManagementCattleIoV3NamespacedProject

read the specified Project

Authorizations:

API Reference - 图202

BearerToken

path Parameters
name
required
string unique

name of the Project

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

Responses

API Reference - 图203200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/namespaces/{namespace}/projects/{name}API Reference - 图204

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projects/{name}

Response samples

  • 200

Content type

API Reference - 图205application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”: {

    • “clusterName”: “string”,

    • “containerDefaultResourceLimit”: {

      • “limitsCpu”: “string”,

      • “limitsMemory”: “string”,

      • “requestsCpu”: “string”,

      • “requestsMemory”: “string”

      },

    • “description”: “string”,

    • “displayName”: “string”,

    • “enableProjectMonitoring”: true,

    • “namespaceDefaultResourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      },

    • “resourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        },

      • “usedLimit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      }

    },

  • “status”: {

    • “conditions”: [

      • {

        • “lastTransitionTime”: “string”,

        • “lastUpdateTime”: “string”,

        • “message”: “string”,

        • “reason”: “string”,

        • “status”: “string”,

        • “type”: “string”

        }

      ],

    • “monitoringStatus”: {

      • “conditions”: [

        • {

          • “lastTransitionTime”: “string”,

          • “lastUpdateTime”: “string”,

          • “message”: “string”,

          • “reason”: “string”,

          • “status”: “string”,

          • “type”: “string”

          }

        ],

      • “grafanaEndpoint”: “string”

      },

    • “podSecurityPolicyTemplateId”: “string”

    }

}`

replaceManagementCattleIoV3NamespacedProject

replace the specified Project

Authorizations:

API Reference - 图206

BearerToken

path Parameters
name
required
string unique

name of the Project

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图207application/jsonapplication/yamlapplication/json

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

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.

object

Spec is the specification of the desired configuration for the project.

object

Status is the most recently observed status of the project.

Responses

API Reference - 图211200

OK

API Reference - 图212201

Created

401

Unauthorized

put/apis/management.cattle.io/v3/namespaces/{namespace}/projects/{name}API Reference - 图213

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projects/{name}

Request samples

  • Payload

Content type

API Reference - 图214application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”: {

    • “clusterName”: “string”,

    • “containerDefaultResourceLimit”: {

      • “limitsCpu”: “string”,

      • “limitsMemory”: “string”,

      • “requestsCpu”: “string”,

      • “requestsMemory”: “string”

      },

    • “description”: “string”,

    • “displayName”: “string”,

    • “enableProjectMonitoring”: true,

    • “namespaceDefaultResourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      },

    • “resourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        },

      • “usedLimit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      }

    },

  • “status”: {

    • “conditions”: [

      • {

        • “lastTransitionTime”: “string”,

        • “lastUpdateTime”: “string”,

        • “message”: “string”,

        • “reason”: “string”,

        • “status”: “string”,

        • “type”: “string”

        }

      ],

    • “monitoringStatus”: {

      • “conditions”: [

        • {

          • “lastTransitionTime”: “string”,

          • “lastUpdateTime”: “string”,

          • “message”: “string”,

          • “reason”: “string”,

          • “status”: “string”,

          • “type”: “string”

          }

        ],

      • “grafanaEndpoint”: “string”

      },

    • “podSecurityPolicyTemplateId”: “string”

    }

}`

Response samples

  • 200
  • 201

Content type

API Reference - 图215application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”: {

    • “clusterName”: “string”,

    • “containerDefaultResourceLimit”: {

      • “limitsCpu”: “string”,

      • “limitsMemory”: “string”,

      • “requestsCpu”: “string”,

      • “requestsMemory”: “string”

      },

    • “description”: “string”,

    • “displayName”: “string”,

    • “enableProjectMonitoring”: true,

    • “namespaceDefaultResourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      },

    • “resourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        },

      • “usedLimit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      }

    },

  • “status”: {

    • “conditions”: [

      • {

        • “lastTransitionTime”: “string”,

        • “lastUpdateTime”: “string”,

        • “message”: “string”,

        • “reason”: “string”,

        • “status”: “string”,

        • “type”: “string”

        }

      ],

    • “monitoringStatus”: {

      • “conditions”: [

        • {

          • “lastTransitionTime”: “string”,

          • “lastUpdateTime”: “string”,

          • “message”: “string”,

          • “reason”: “string”,

          • “status”: “string”,

          • “type”: “string”

          }

        ],

      • “grafanaEndpoint”: “string”

      },

    • “podSecurityPolicyTemplateId”: “string”

    }

}`

deleteManagementCattleIoV3NamespacedProject

delete a Project

Authorizations:

API Reference - 图216

BearerToken

path Parameters
name
required
string unique

name of the Project

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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

gracePeriodSeconds
integer unique

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents
boolean unique

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy
string unique

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Request Body schema:

API Reference - 图217application/jsonapplication/yamlapplication/json

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

dryRun
Array of strings

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

gracePeriodSeconds
integer <int64>

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

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

orphanDependents
boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

object (io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions)

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

propagationPolicy
string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Responses

API Reference - 图219200

OK

API Reference - 图220202

Accepted

401

Unauthorized

delete/apis/management.cattle.io/v3/namespaces/{namespace}/projects/{name}API Reference - 图221

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projects/{name}

Request samples

  • Payload

Content type

API Reference - 图222application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “dryRun”: [

    • “string”

    ],

  • “gracePeriodSeconds”: 0,

  • “kind”: “string”,

  • “orphanDependents”: true,

  • “preconditions”: {

    • “resourceVersion”: “string”,

    • “uid”: “string”

    },

  • “propagationPolicy”: “string”

}`

Response samples

  • 200
  • 202

Content type

API Reference - 图223application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

patchManagementCattleIoV3NamespacedProject

partially update the specified Project

Authorizations:

API Reference - 图224

BearerToken

path Parameters
name
required
string unique

name of the Project

namespace
required
string unique

object name and auth scope, such as for teams and projects

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

fieldValidation
string unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

force
boolean unique

Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Request Body schema:

API Reference - 图225application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

object (io.k8s.apimachinery.pkg.apis.meta.v1.Patch)

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Responses

API Reference - 图226200

OK

401

Unauthorized

patch/apis/management.cattle.io/v3/namespaces/{namespace}/projects/{name}API Reference - 图227

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/namespaces/{namespace}/projects/{name}

Request samples

  • Payload

Content type

API Reference - 图228application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

Copy

{ }

Response samples

  • 200

Content type

API Reference - 图229application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “kind”: “string”,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”: {

    • “clusterName”: “string”,

    • “containerDefaultResourceLimit”: {

      • “limitsCpu”: “string”,

      • “limitsMemory”: “string”,

      • “requestsCpu”: “string”,

      • “requestsMemory”: “string”

      },

    • “description”: “string”,

    • “displayName”: “string”,

    • “enableProjectMonitoring”: true,

    • “namespaceDefaultResourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      },

    • “resourceQuota”: {

      • “limit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        },

      • “usedLimit”: {

        • “configMaps”: “string”,

        • “limitsCpu”: “string”,

        • “limitsMemory”: “string”,

        • “persistentVolumeClaims”: “string”,

        • “pods”: “string”,

        • “replicationControllers”: “string”,

        • “requestsCpu”: “string”,

        • “requestsMemory”: “string”,

        • “requestsStorage”: “string”,

        • “secrets”: “string”,

        • “services”: “string”,

        • “servicesLoadBalancers”: “string”,

        • “servicesNodePorts”: “string”

        }

      }

    },

  • “status”: {

    • “conditions”: [

      • {

        • “lastTransitionTime”: “string”,

        • “lastUpdateTime”: “string”,

        • “message”: “string”,

        • “reason”: “string”,

        • “status”: “string”,

        • “type”: “string”

        }

      ],

    • “monitoringStatus”: {

      • “conditions”: [

        • {

          • “lastTransitionTime”: “string”,

          • “lastUpdateTime”: “string”,

          • “message”: “string”,

          • “reason”: “string”,

          • “status”: “string”,

          • “type”: “string”

          }

        ],

      • “grafanaEndpoint”: “string”

      },

    • “podSecurityPolicyTemplateId”: “string”

    }

}`

listManagementCattleIoV3ProjectRoleTemplateBindingForAllNamespaces

list objects of kind ProjectRoleTemplateBinding

Authorizations:

API Reference - 图230

BearerToken

query Parameters
allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

pretty
string unique

If ‘true’, then the output is pretty printed.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图231200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/projectroletemplatebindingsAPI Reference - 图232

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/projectroletemplatebindings

Response samples

  • 200

Content type

API Reference - 图233application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “items”: [

    • {

      • “apiVersion”: “string”,

      • “groupName”: “string”,

      • “groupPrincipalName”: “string”,

      • “kind”: “string”,

      • “metadata”: {

        • “annotations”: {

          • “property1”: “string”,

          • “property2”: “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”

        },

      • “projectName”: “string”,

      • “roleTemplateName”: “string”,

      • “serviceAccount”: “string”,

      • “userName”: “string”,

      • “userPrincipalName”: “string”

      }

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    }

}`

listManagementCattleIoV3ProjectForAllNamespaces

list objects of kind Project

Authorizations:

API Reference - 图234

BearerToken

query Parameters
allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

pretty
string unique

If ‘true’, then the output is pretty printed.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图235200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/projectsAPI Reference - 图236

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/projects

Response samples

  • 200

Content type

API Reference - 图237application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “items”: [

    • {

      • “apiVersion”: “string”,

      • “kind”: “string”,

      • “metadata”: {

        • “annotations”: {

          • “property1”: “string”,

          • “property2”: “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”: {

        • “clusterName”: “string”,

        • “containerDefaultResourceLimit”: {

          • “limitsCpu”: “string”,

          • “limitsMemory”: “string”,

          • “requestsCpu”: “string”,

          • “requestsMemory”: “string”

          },

        • “description”: “string”,

        • “displayName”: “string”,

        • “enableProjectMonitoring”: true,

        • “namespaceDefaultResourceQuota”: {

          • “limit”: {

            • “configMaps”: “string”,

            • “limitsCpu”: “string”,

            • “limitsMemory”: “string”,

            • “persistentVolumeClaims”: “string”,

            • “pods”: “string”,

            • “replicationControllers”: “string”,

            • “requestsCpu”: “string”,

            • “requestsMemory”: “string”,

            • “requestsStorage”: “string”,

            • “secrets”: “string”,

            • “services”: “string”,

            • “servicesLoadBalancers”: “string”,

            • “servicesNodePorts”: “string”

            }

          },

        • “resourceQuota”: {

          • “limit”: {

            • “configMaps”: “string”,

            • “limitsCpu”: “string”,

            • “limitsMemory”: “string”,

            • “persistentVolumeClaims”: “string”,

            • “pods”: “string”,

            • “replicationControllers”: “string”,

            • “requestsCpu”: “string”,

            • “requestsMemory”: “string”,

            • “requestsStorage”: “string”,

            • “secrets”: “string”,

            • “services”: “string”,

            • “servicesLoadBalancers”: “string”,

            • “servicesNodePorts”: “string”

            },

          • “usedLimit”: {

            • “configMaps”: “string”,

            • “limitsCpu”: “string”,

            • “limitsMemory”: “string”,

            • “persistentVolumeClaims”: “string”,

            • “pods”: “string”,

            • “replicationControllers”: “string”,

            • “requestsCpu”: “string”,

            • “requestsMemory”: “string”,

            • “requestsStorage”: “string”,

            • “secrets”: “string”,

            • “services”: “string”,

            • “servicesLoadBalancers”: “string”,

            • “servicesNodePorts”: “string”

            }

          }

        },

      • “status”: {

        • “conditions”: [

          • {

            • “lastTransitionTime”: “string”,

            • “lastUpdateTime”: “string”,

            • “message”: “string”,

            • “reason”: “string”,

            • “status”: “string”,

            • “type”: “string”

            }

          ],

        • “monitoringStatus”: {

          • “conditions”: [

            • {

              • “lastTransitionTime”: “string”,

              • “lastUpdateTime”: “string”,

              • “message”: “string”,

              • “reason”: “string”,

              • “status”: “string”,

              • “type”: “string”

              }

            ],

          • “grafanaEndpoint”: “string”

          },

        • “podSecurityPolicyTemplateId”: “string”

        }

      }

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    }

}`

listManagementCattleIoV3RoleTemplate

list objects of kind RoleTemplate

Authorizations:

API Reference - 图238

BearerToken

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图239200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/roletemplatesAPI Reference - 图240

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/roletemplates

Response samples

  • 200

Content type

API Reference - 图241application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “items”: [

    • {

      • “administrative”: true,

      • “apiVersion”: “string”,

      • “builtin”: true,

      • “clusterCreatorDefault”: true,

      • “context”: “project”,

      • “description”: “string”,

      • “displayName”: “string”,

      • “external”: true,

      • “hidden”: true,

      • “kind”: “string”,

      • “locked”: true,

      • “metadata”: {

        • “annotations”: {

          • “property1”: “string”,

          • “property2”: “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”

        },

      • “projectCreatorDefault”: true,

      • “roleTemplateNames”: [

        • “string”

        ],

      • “rules”: [

        • {

          • “apiGroups”: [

            • “string”

            ],

          • “nonResourceURLs”: [

            • “string”

            ],

          • “resourceNames”: [

            • “string”

            ],

          • “resources”: [

            • “string”

            ],

          • “verbs”: [

            • “string”

            ]

          }

        ]

      }

    ],

  • “kind”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    }

}`

createManagementCattleIoV3RoleTemplate

create a RoleTemplate

Authorizations:

API Reference - 图242

BearerToken

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图243application/jsonapplication/yamlapplication/json

administrative
boolean

Administrative if false, and context is set to cluster this RoleTemplate will not grant access to “CatalogTemplates” and “CatalogTemplateVersions” for any project in the cluster. Default is false.

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

builtin
boolean

Builtin if true specifies that this RoleTemplate was created by Rancher and is immutable. Default to false.

clusterCreatorDefault
boolean

ClusterCreatorDefault if true, a binding with this RoleTemplate will be created for a users when they create a new cluster. ClusterCreatorDefault is only evaluated if the context of the RoleTemplate is set to cluster. Default to false.

context
string
Enum: “project” “cluster” “”

Context describes if the roleTemplate applies to clusters or projects. Valid values are “project”, “cluster” or “”.

description
string

Description holds text that describes the resource.

displayName
string

DisplayName is the human-readable name displayed in the UI for this resource.

external
boolean

External if true specifies that rules for this RoleTemplate should be gathered from a ClusterRole with the matching name. If set to true the Rules on the template will not be evaluated. External’s value is only evaluated if the RoleTemplate’s context is set to “cluster” Default to false.

hidden
boolean

Hidden if true informs the Rancher UI not to display this RoleTemplate. Default to false.

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

locked
boolean

Locked if true, new bindings will not be able to use this RoleTemplate. Default to false.

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.

projectCreatorDefault
boolean

ProjectCreatorDefault if true, a binding with this RoleTemplate will be created for a user when they create a new project. ProjectCreatorDefault is only evaluated if the context of the RoleTemplate is set to project. Default to false.

roleTemplateNames
Array of strings

RoleTemplateNames list of RoleTemplate names that this RoleTemplate will inherit. This RoleTemplate will grant all rules defined in an inherited RoleTemplate. Inherited RoleTemplates must already exist.

Array of objects

Rules hold all the PolicyRules for this RoleTemplate.

Responses

API Reference - 图246200

OK

API Reference - 图247201

Created

API Reference - 图248202

Accepted

401

Unauthorized

post/apis/management.cattle.io/v3/roletemplatesAPI Reference - 图249

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/roletemplates

Request samples

  • Payload

Content type

API Reference - 图250application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “administrative”: true,

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “clusterCreatorDefault”: true,

  • “context”: “project”,

  • “description”: “string”,

  • “displayName”: “string”,

  • “external”: true,

  • “hidden”: true,

  • “kind”: “string”,

  • “locked”: true,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectCreatorDefault”: true,

  • “roleTemplateNames”: [

    • “string”

    ],

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

Response samples

  • 200
  • 201
  • 202

Content type

API Reference - 图251application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “administrative”: true,

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “clusterCreatorDefault”: true,

  • “context”: “project”,

  • “description”: “string”,

  • “displayName”: “string”,

  • “external”: true,

  • “hidden”: true,

  • “kind”: “string”,

  • “locked”: true,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectCreatorDefault”: true,

  • “roleTemplateNames”: [

    • “string”

    ],

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

deleteManagementCattleIoV3CollectionRoleTemplate

delete collection of RoleTemplate

Authorizations:

API Reference - 图252

BearerToken

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

allowWatchBookmarks
boolean unique

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue
string unique

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector
string unique

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector
string unique

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit
integer unique

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch
string unique

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents
boolean unique

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with “k8s.io/initial-events-end”: “true” annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion“ and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

  • resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion=”” or resourceVersion=”0” (for backward compatibility reasons) and to false otherwise.

timeoutSeconds
integer unique

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch
boolean unique

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

API Reference - 图253200

OK

401

Unauthorized

delete/apis/management.cattle.io/v3/roletemplatesAPI Reference - 图254

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/roletemplates

Response samples

  • 200

Content type

API Reference - 图255application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

readManagementCattleIoV3RoleTemplate

read the specified RoleTemplate

Authorizations:

API Reference - 图256

BearerToken

path Parameters
name
required
string unique

name of the RoleTemplate

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

resourceVersion
string unique

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

Responses

API Reference - 图257200

OK

401

Unauthorized

get/apis/management.cattle.io/v3/roletemplates/{name}API Reference - 图258

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/roletemplates/{name}

Response samples

  • 200

Content type

API Reference - 图259application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “administrative”: true,

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “clusterCreatorDefault”: true,

  • “context”: “project”,

  • “description”: “string”,

  • “displayName”: “string”,

  • “external”: true,

  • “hidden”: true,

  • “kind”: “string”,

  • “locked”: true,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectCreatorDefault”: true,

  • “roleTemplateNames”: [

    • “string”

    ],

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

replaceManagementCattleIoV3RoleTemplate

replace the specified RoleTemplate

Authorizations:

API Reference - 图260

BearerToken

path Parameters
name
required
string unique

name of the RoleTemplate

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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 unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Request Body schema:

API Reference - 图261application/jsonapplication/yamlapplication/json

administrative
boolean

Administrative if false, and context is set to cluster this RoleTemplate will not grant access to “CatalogTemplates” and “CatalogTemplateVersions” for any project in the cluster. Default is false.

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

builtin
boolean

Builtin if true specifies that this RoleTemplate was created by Rancher and is immutable. Default to false.

clusterCreatorDefault
boolean

ClusterCreatorDefault if true, a binding with this RoleTemplate will be created for a users when they create a new cluster. ClusterCreatorDefault is only evaluated if the context of the RoleTemplate is set to cluster. Default to false.

context
string
Enum: “project” “cluster” “”

Context describes if the roleTemplate applies to clusters or projects. Valid values are “project”, “cluster” or “”.

description
string

Description holds text that describes the resource.

displayName
string

DisplayName is the human-readable name displayed in the UI for this resource.

external
boolean

External if true specifies that rules for this RoleTemplate should be gathered from a ClusterRole with the matching name. If set to true the Rules on the template will not be evaluated. External’s value is only evaluated if the RoleTemplate’s context is set to “cluster” Default to false.

hidden
boolean

Hidden if true informs the Rancher UI not to display this RoleTemplate. Default to false.

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

locked
boolean

Locked if true, new bindings will not be able to use this RoleTemplate. Default to false.

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.

projectCreatorDefault
boolean

ProjectCreatorDefault if true, a binding with this RoleTemplate will be created for a user when they create a new project. ProjectCreatorDefault is only evaluated if the context of the RoleTemplate is set to project. Default to false.

roleTemplateNames
Array of strings

RoleTemplateNames list of RoleTemplate names that this RoleTemplate will inherit. This RoleTemplate will grant all rules defined in an inherited RoleTemplate. Inherited RoleTemplates must already exist.

Array of objects

Rules hold all the PolicyRules for this RoleTemplate.

Responses

API Reference - 图264200

OK

API Reference - 图265201

Created

401

Unauthorized

put/apis/management.cattle.io/v3/roletemplates/{name}API Reference - 图266

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/roletemplates/{name}

Request samples

  • Payload

Content type

API Reference - 图267application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “administrative”: true,

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “clusterCreatorDefault”: true,

  • “context”: “project”,

  • “description”: “string”,

  • “displayName”: “string”,

  • “external”: true,

  • “hidden”: true,

  • “kind”: “string”,

  • “locked”: true,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectCreatorDefault”: true,

  • “roleTemplateNames”: [

    • “string”

    ],

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

Response samples

  • 200
  • 201

Content type

API Reference - 图268application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “administrative”: true,

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “clusterCreatorDefault”: true,

  • “context”: “project”,

  • “description”: “string”,

  • “displayName”: “string”,

  • “external”: true,

  • “hidden”: true,

  • “kind”: “string”,

  • “locked”: true,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectCreatorDefault”: true,

  • “roleTemplateNames”: [

    • “string”

    ],

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`

deleteManagementCattleIoV3RoleTemplate

delete a RoleTemplate

Authorizations:

API Reference - 图269

BearerToken

path Parameters
name
required
string unique

name of the RoleTemplate

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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

gracePeriodSeconds
integer unique

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents
boolean unique

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy
string unique

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Request Body schema:

API Reference - 图270application/jsonapplication/yamlapplication/json

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

dryRun
Array of strings

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

gracePeriodSeconds
integer <int64>

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

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

orphanDependents
boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

object (io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions)

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

propagationPolicy
string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Responses

API Reference - 图272200

OK

API Reference - 图273202

Accepted

401

Unauthorized

delete/apis/management.cattle.io/v3/roletemplates/{name}API Reference - 图274

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/roletemplates/{name}

Request samples

  • Payload

Content type

API Reference - 图275application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “dryRun”: [

    • “string”

    ],

  • “gracePeriodSeconds”: 0,

  • “kind”: “string”,

  • “orphanDependents”: true,

  • “preconditions”: {

    • “resourceVersion”: “string”,

    • “uid”: “string”

    },

  • “propagationPolicy”: “string”

}`

Response samples

  • 200
  • 202

Content type

API Reference - 图276application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “apiVersion”: “string”,

  • “code”: 0,

  • “details”: {

    • “causes”: [

      • {

        • “field”: “string”,

        • “message”: “string”,

        • “reason”: “string”

        }

      ],

    • “group”: “string”,

    • “kind”: “string”,

    • “name”: “string”,

    • “retryAfterSeconds”: 0,

    • “uid”: “string”

    },

  • “kind”: “string”,

  • “message”: “string”,

  • “metadata”: {

    • “continue”: “string”,

    • “remainingItemCount”: 0,

    • “resourceVersion”: “string”,

    • “selfLink”: “string”

    },

  • “reason”: “string”,

  • “status”: “string”

}`

patchManagementCattleIoV3RoleTemplate

partially update the specified RoleTemplate

Authorizations:

API Reference - 图277

BearerToken

path Parameters
name
required
string unique

name of the RoleTemplate

query Parameters
pretty
string unique

If ‘true’, then the output is pretty printed.

dryRun
string unique

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 unique

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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

fieldValidation
string unique

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

force
boolean unique

Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Request Body schema:

API Reference - 图278application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

object (io.k8s.apimachinery.pkg.apis.meta.v1.Patch)

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Responses

API Reference - 图279200

OK

401

Unauthorized

patch/apis/management.cattle.io/v3/roletemplates/{name}API Reference - 图280

https://ranchermanager.docs.rancher.com/apis/management.cattle.io/v3/roletemplates/{name}

Request samples

  • Payload

Content type

API Reference - 图281application/json-patch+jsonapplication/merge-patch+jsonapplication/apply-patch+yamlapplication/json-patch+json

Copy

{ }

Response samples

  • 200

Content type

API Reference - 图282application/jsonapplication/yamlapplication/json

Copy

Expand all Collapse all

`{

  • “administrative”: true,

  • “apiVersion”: “string”,

  • “builtin”: true,

  • “clusterCreatorDefault”: true,

  • “context”: “project”,

  • “description”: “string”,

  • “displayName”: “string”,

  • “external”: true,

  • “hidden”: true,

  • “kind”: “string”,

  • “locked”: true,

  • “metadata”: {

    • “annotations”: {

      • “property1”: “string”,

      • “property2”: “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”

    },

  • “projectCreatorDefault”: true,

  • “roleTemplateNames”: [

    • “string”

    ],

  • “rules”: [

    • {

      • “apiGroups”: [

        • “string”

        ],

      • “nonResourceURLs”: [

        • “string”

        ],

      • “resourceNames”: [

        • “string”

        ],

      • “resources”: [

        • “string”

        ],

      • “verbs”: [

        • “string”

        ]

      }

    ]

}`