Project [auth.alauda.io/v1]

This API is installed only when the chart is deployed for the global cluster. It is not available on workload clusters.

描述: Project is the Schema for the projects API
类型: object

规格

属性	类型	描述
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	ProjectSpec defines the desired state of Project
`status`	`object`	ProjectStatus defines the observed state of Project

.spec

描述: ProjectSpec defines the desired state of Project
类型: object

属性	类型	描述
`clusterDeletePolicy`	`string`
`clusters`	`array`	Clusters contains the clusters associated with this Project

.spec.clusters

描述: Clusters contains the clusters associated with this Project
类型: array

.spec.clusters[]

描述: ProjectClusters is the attribute for ProjectSpec
类型: object
必填: namequota

属性	类型	描述
`name`	`string`	Name of the cluster
`quota`	`object`	Quota store the quota info for Project
`type`	`string`	Type of the cluster

.spec.clusters[].quota

描述: Quota store the quota info for Project
类型: object

.status

描述: ProjectStatus defines the observed state of Project
类型: object

属性	类型	描述
`conditions`	`array`
`phase`	`string`	Phase record the state of project
`reason`	`string`
`version`	`string`

.status.conditions

类型: array

.status.conditions[]

描述: ProjectCondition contains condition information for a cluster.
类型: object
必填: statustype

属性	类型	描述
`lastTransitionTime`	`string`	LastTransitionTime is the last time the condition changed from one status to another.
`message`	`string`	Message is a human-readable message indicating details about the last status change.
`projectNameSpaceDetail`	`object`	用来记录project同名命名空间详细信息
`reason`	`string`	Reason is a (brief) reason for the condition's last status change.
`status`	`string`	Status is the status of the condition. One of True, False, Unknown.
`type`	`string`	Type is the type of the cluster condition.

.status.conditions[].projectNameSpaceDetail

描述: 用来记录project同名命名空间详细信息
类型: object

属性	类型	描述
`failedClusters`	`object`
`name`	`string`	原始的项目名称，即要创建ns的名称
`successClusters`	`object`

.status.conditions[].projectNameSpaceDetail.failedClusters

类型: object

.status.conditions[].projectNameSpaceDetail.successClusters

类型: object

API 端点

可用的 API 端点如下：

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

/apis/auth.alauda.io/v1/projects

HTTP 方法: DELETE
描述: delete collection of Project
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind Project
HTTP 响应

HTTP 状态码	响应体
200 - OK	`ProjectList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new Project

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	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.

请求体参数

参数	类型	描述
`body`	`Project` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`Project` schema
201 - Created	`Project` schema
202 - Accepted	`Project` schema
401 - Unauthorized	Empty

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

HTTP 方法: DELETE
描述: delete the specified Project

查询参数

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

HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified Project
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Project` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified Project

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	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.

HTTP 响应

HTTP 状态码	响应体
200 - OK	`Project` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified Project

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	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.

请求体参数

参数	类型	描述
`body`	`Project` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`Project` schema
201 - Created	`Project` schema
401 - Unauthorized	Empty

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

HTTP 方法: GET
描述: read status of the specified Project
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Project` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update status of the specified Project

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	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.

HTTP 响应

HTTP 状态码	响应体
200 - OK	`Project` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace status of the specified Project

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	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.

请求体参数

参数	类型	描述
`body`	`Project` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`Project` schema
201 - Created	`Project` schema
401 - Unauthorized	Empty

#Project [auth.alauda.io/v1]

#规格

#.spec

#.spec.clusters

#.spec.clusters[]

#.spec.clusters[].quota

#.status

#.status.conditions

#.status.conditions[]

#.status.conditions[].projectNameSpaceDetail

#.status.conditions[].projectNameSpaceDetail.failedClusters

#.status.conditions[].projectNameSpaceDetail.successClusters

API 端点#

/apis/auth.alauda.io/v1/projects#

/apis/auth.alauda.io/v1/projects/{name}#

/apis/auth.alauda.io/v1/projects/{name}/status#

Project [auth.alauda.io/v1]

规格

.spec

.spec.clusters

.spec.clusters[]

.spec.clusters[].quota

.status

.status.conditions

.status.conditions[]

.status.conditions[].projectNameSpaceDetail

.status.conditions[].projectNameSpaceDetail.failedClusters

.status.conditions[].projectNameSpaceDetail.successClusters

API 端点

/apis/auth.alauda.io/v1/projects

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

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