Alauda Container Platform

简体中文

ProductEntry [alauda.io/v1alpha1]

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

描述: ProductEntry is the Schema for the productentries 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`	ProductEntrySpec defines the desired state of ProductEntry
`status`	`object`	ProductEntryStatus defines the observed state of ProductEntry

.spec

描述: ProductEntrySpec defines the desired state of ProductEntry
类型: object
必填: descriptiondisplayNameentrypointlogopackTypeversion

属性	类型	描述
`catalog`	`object`	Catalog stands for the product's catalog
`description`	`object`	Description stands for the product's description
`displayName`	`object`	DisplayName stands for the product's display name
`entrypoint`	`string`	Entrypoint stands for the entrypoint of sub app
`logo`	`string`	Logo stands for the product logo with base64 encoded data uri
`packType`	`string`	PackType is the product's package type
`ssoEnabled`	`boolean`	SSOEnabled stands for if SSO enabled
`version`	`string`	Version stands for product version
`entryTarget`	`string`

.spec.catalog

描述: Catalog stands for the product's catalog
类型: object

属性	类型	描述
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

.spec.description

描述: Description stands for the product's description
类型: object

属性	类型	描述
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

.spec.displayName

描述: DisplayName stands for the product's display name
类型: object

属性	类型	描述
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

.status

描述: ProductEntryStatus defines the observed state of ProductEntry
类型: object

属性	类型	描述
`hiddenOnMenu`	`boolean`	HiddenOnPortal stands for if this product is hidden on menu
`hiddenOnPortal`	`boolean`	HiddenOnPortal stands for if this product is hidden on portal
`orderOnMenu`	`integer`	OrderOnMenu stands for the product's order on menu
`orderOnPortal`	`integer`	OrderOnPortal stands for the product's order on portal

API 端点

可用的 API 端点如下：

/apis/alauda.io/v1alpha1/productentries
- DELETE: delete collection of ProductEntry
- GET: list objects of kind ProductEntry
- POST: create a new ProductEntry
/apis/alauda.io/v1alpha1/productentries/{name}
- DELETE: delete the specified ProductEntry
- GET: read the specified ProductEntry
- PATCH: partially update the specified ProductEntry
- PUT: replace the specified ProductEntry

/apis/alauda.io/v1alpha1/productentries

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

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

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

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

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

查询参数

参数	类型	描述
`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`	`ProductEntry` schema	`application/json` formatted

HTTP 响应

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

/apis/alauda.io/v1alpha1/productentries/{name}

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

查询参数

参数	类型	描述
`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 ProductEntry
HTTP 响应

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

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

查询参数

参数	类型	描述
`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	`ProductEntry` schema
401 - Unauthorized	Empty

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

查询参数

参数	类型	描述
`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`	`ProductEntry` schema	`application/json` formatted

HTTP 响应

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