Alauda Container Platform
  • 简体中文

    • UserBinding [auth.alauda.io/v1]

    描述
    UserBinding is the Schema for the userbindings API
    类型
    object

    规格

    属性类型描述
    apiVersionstring

    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

    kindstring

    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

    metadataObjectMeta

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    specobject

    UserBindingSpec defines the desired state of UserBinding

    statusobject

    UserBindingStatus defines the observed state of UserBinding

    .spec

    描述
    UserBindingSpec defines the desired state of UserBinding
    类型
    object
    属性类型描述
    constraintarray
    roleRefstring
    scopestring
    subjectsarray

    .spec.constraint

    类型
    array

    .spec.constraint[]

    类型
    object
    属性类型描述
    clusterstring
    namespacestring
    projectstring

    .spec.subjects

    类型
    array

    .spec.subjects[]

    类型
    object
    必填
    kindname
    属性类型描述
    kindstring
    namestring

    .status

    描述
    UserBindingStatus defines the observed state of UserBinding
    类型
    object
    属性类型描述
    bindingsCreatedobject

    BindingsCreated records the count of created bindings

    conditionsarray
    failedClustersarray

    FailedClusters lists clusters that failed to sync (global cluster only)

    failureDetailsobject

    FailureDetails contains detailed error information for troubleshooting

    lastReconcileTimestring

    LastReconcileTime records the last successful reconcile time Used to detect if reconciliation is stuck

    lastSpecHashstring
    nextRetryTimestring

    NextRetryTime indicates when the next retry will be attempted

    observedGenerationinteger

    ObservedGeneration records the last processed Generation Used to determine if status is stale

    phasestring
    retryCountinteger

    RetryCount tracks the number of retry attempts

    syncedClustersarray

    SyncedClusters lists successfully synced clusters (global cluster only)

    .status.bindingsCreated

    描述
    BindingsCreated records the count of created bindings
    类型
    object
    属性类型描述
    clusterRoleBindingsinteger

    ClusterRoleBindings count of created ClusterRoleBindings

    roleBindingsinteger

    RoleBindings count of created RoleBindings

    .status.conditions

    类型
    array

    .status.conditions[]

    类型
    object
    属性类型描述
    lastTransitionTimestring
    messagestring
    reasonstring
    statusstring
    typestring

    .status.failedClusters

    描述
    FailedClusters lists clusters that failed to sync (global cluster only)
    类型
    array

    .status.failedClusters[]

    类型
    string

    .status.failureDetails

    描述
    FailureDetails contains detailed error information for troubleshooting
    类型
    object
    属性类型描述
    affectedItemsarray

    AffectedItems lists the specific resources that failed

    failureMessagestring

    FailureMessage is a human-readable detailed error message

    failureReasonstring

    FailureReason is a short, machine-readable reason for the failure

    lastFailureTimestring

    LastFailureTime records when the last failure occurred

    .status.failureDetails.affectedItems

    描述
    AffectedItems lists the specific resources that failed
    类型
    array

    .status.failureDetails.affectedItems[]

    描述
    AffectedItem represents a specific resource that failed during reconciliation
    类型
    object
    属性类型描述
    errorstring

    Error is the specific error message for this item

    namestring

    Name is the name of the affected resource

    namespacestring

    Namespace is the namespace of the resource (for RoleBinding)

    typestring

    Type is the resource type (ClusterRoleBinding, RoleBinding, etc.)

    .status.syncedClusters

    描述
    SyncedClusters lists successfully synced clusters (global cluster only)
    类型
    array

    .status.syncedClusters[]

    类型
    string

    API 端点

    可用的 API 端点如下：

    • /apis/auth.alauda.io/v1/userbindings
      • DELETE: delete collection of UserBinding
      • GET: list objects of kind UserBinding
      • POST: create a new UserBinding
    • /apis/auth.alauda.io/v1/userbindings/{name}
      • DELETE: delete the specified UserBinding
      • GET: read the specified UserBinding
      • PATCH: partially update the specified UserBinding
      • PUT: replace the specified UserBinding
    • /apis/auth.alauda.io/v1/userbindings/{name}/status
      • GET: read status of the specified UserBinding
      • PATCH: partially update status of the specified UserBinding
      • PUT: replace status of the specified UserBinding

    /apis/auth.alauda.io/v1/userbindings

    HTTP 方法
    DELETE
    描述
    delete collection of UserBinding
    HTTP 响应
    HTTP 状态码响应体
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP 方法
    GET
    描述
    list objects of kind UserBinding
    HTTP 响应
    HTTP 状态码响应体
    200 - OKUserBindingList schema
    401 - UnauthorizedEmpty
    HTTP 方法
    POST
    描述
    create a new UserBinding
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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.
    请求体参数
    参数类型描述
    bodyUserBinding schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKUserBinding schema
    201 - CreatedUserBinding schema
    202 - AcceptedUserBinding schema
    401 - UnauthorizedEmpty

    /apis/auth.alauda.io/v1/userbindings/{name}

    HTTP 方法
    DELETE
    描述
    delete the specified UserBinding
    查询参数
    参数类型描述
    dryRunstringWhen 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
    HTTP 响应
    HTTP 状态码响应体
    200 - OKStatus schema
    202 - AcceptedStatus schema
    401 - UnauthorizedEmpty
    HTTP 方法
    GET
    描述
    read the specified UserBinding
    HTTP 响应
    HTTP 状态码响应体
    200 - OKUserBinding schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update the specified UserBinding
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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.
    HTTP 响应
    HTTP 状态码响应体
    200 - OKUserBinding schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace the specified UserBinding
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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.
    请求体参数
    参数类型描述
    bodyUserBinding schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKUserBinding schema
    201 - CreatedUserBinding schema
    401 - UnauthorizedEmpty

    /apis/auth.alauda.io/v1/userbindings/{name}/status

    HTTP 方法
    GET
    描述
    read status of the specified UserBinding
    HTTP 响应
    HTTP 状态码响应体
    200 - OKUserBinding schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update status of the specified UserBinding
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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.
    HTTP 响应
    HTTP 状态码响应体
    200 - OKUserBinding schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace status of the specified UserBinding
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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.
    请求体参数
    参数类型描述
    bodyUserBinding schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKUserBinding schema
    201 - CreatedUserBinding schema
    401 - UnauthorizedEmpty