이 콘텐츠는 선택한 언어로 제공되지 않습니다.
Chapter 4. DataImage [metal3.io/v1alpha1]
- Description
- DataImage is the Schema for the dataimages API.
- Type
-
object
4.1. Specification 링크 복사링크가 클립보드에 복사되었습니다!
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| DataImageSpec defines the desired state of DataImage. |
|
| DataImageStatus defines the observed state of DataImage. |
4.1.1. .spec 링크 복사링크가 클립보드에 복사되었습니다!
- Description
- DataImageSpec defines the desired state of DataImage.
- Type
-
object
- Required
-
url
-
Property | Type | Description |
---|---|---|
|
| Url is the address of the dataImage that we want to attach to a BareMetalHost |
4.1.2. .status 링크 복사링크가 클립보드에 복사되었습니다!
- Description
- DataImageStatus defines the observed state of DataImage.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| Currently attached DataImage |
|
| Error count and message when attaching/detaching |
|
| Time of last reconciliation |
4.1.3. .status.attachedImage 링크 복사링크가 클립보드에 복사되었습니다!
- Description
- Currently attached DataImage
- Type
-
object
- Required
-
url
-
Property | Type | Description |
---|---|---|
|
|
4.1.4. .status.error 링크 복사링크가 클립보드에 복사되었습니다!
- Description
- Error count and message when attaching/detaching
- Type
-
object
- Required
-
count
-
message
-
Property | Type | Description |
---|---|---|
|
| |
|
|
4.2. API endpoints 링크 복사링크가 클립보드에 복사되었습니다!
The following API endpoints are available:
/apis/metal3.io/v1alpha1/dataimages
-
GET
: list objects of kind DataImage
-
/apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages
-
DELETE
: delete collection of DataImage -
GET
: list objects of kind DataImage -
POST
: create a DataImage
-
/apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}
-
DELETE
: delete a DataImage -
GET
: read the specified DataImage -
PATCH
: partially update the specified DataImage -
PUT
: replace the specified DataImage
-
/apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status
-
GET
: read status of the specified DataImage -
PATCH
: partially update status of the specified DataImage -
PUT
: replace status of the specified DataImage
-
4.2.1. /apis/metal3.io/v1alpha1/dataimages 링크 복사링크가 클립보드에 복사되었습니다!
- HTTP method
-
GET
- Description
- list objects of kind DataImage
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
4.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages 링크 복사링크가 클립보드에 복사되었습니다!
- HTTP method
-
DELETE
- Description
- delete collection of DataImage
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- list objects of kind DataImage
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
POST
- Description
- create a DataImage
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
4.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name} 링크 복사링크가 클립보드에 복사되었습니다!
Parameter | Type | Description |
---|---|---|
|
| name of the DataImage |
- HTTP method
-
DELETE
- Description
- delete a DataImage
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- read the specified DataImage
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update the specified DataImage
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace the specified DataImage
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
4.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status 링크 복사링크가 클립보드에 복사되었습니다!
Parameter | Type | Description |
---|---|---|
|
| name of the DataImage |
- HTTP method
-
GET
- Description
- read status of the specified DataImage
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update status of the specified DataImage
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace status of the specified DataImage
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|