1.4. Placementrules API
1.4.1. Overview
This documentation is for the Placementrule resource for Red Hat Advanced Cluster Management for Kubernetes. The Placementrule resource has four possible requests: create, query, delete and update.
1.4.1.1. Version information
Version : 2.0.0
1.4.1.2. Contact information
Contact Email : apiteam@swagger.io
1.4.1.3. License information
						License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
					
1.4.1.4. URI scheme
						BasePath : /kubernetes/apis
Schemes : HTTPS
					
1.4.1.5. Tags
- placementrules.apps.open-cluster-management.io : Create and manage placementrules
1.4.1.6. External Docs
						Description : Find out more about Swagger.
URL : http://swagger.io
					
1.4.2. Paths
1.4.2.1. Create a placementrule
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules1.4.2.1.1. Description
Create a placementrule.
1.4.2.1.2. Parameters
| Type | Name | Description | Schema | 
|---|---|---|---|
| Header | 
											COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string | 
| Path | 
											namespace | Namespace that you want to use, for example, default. | string | 
| Body | 
											body | Parameters describing the placementrule to be created. | 
1.4.2.1.3. Responses
| HTTP Code | Description | Schema | 
|---|---|---|
| 200 | Success | No Content | 
| 403 | Access forbidden | No Content | 
| 404 | Resource not found | No Content | 
| 500 | Internal service error | No Content | 
| 503 | Service unavailable | No Content | 
1.4.2.1.4. Consumes
- 
									application/yaml
1.4.2.1.5. Tags
- placementrules.apps.open-cluster-management.io
1.4.2.1.6. Example HTTP request
1.4.2.1.6.1. Request body
1.4.2.2. Query all placementrules
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules1.4.2.2.1. Description
Query your placementrules for more details.
1.4.2.2.2. Parameters
| Type | Name | Description | Schema | 
|---|---|---|---|
| Header | 
											COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string | 
| Path | 
											namespace | Namespace that you want to use, for example, default. | string | 
1.4.2.2.3. Responses
| HTTP Code | Description | Schema | 
|---|---|---|
| 200 | Success | No Content | 
| 403 | Access forbidden | No Content | 
| 404 | Resource not found | No Content | 
| 500 | Internal service error | No Content | 
| 503 | Service unavailable | No Content | 
1.4.2.2.4. Consumes
- 
									application/yaml
1.4.2.2.5. Tags
- placementrules.apps.open-cluster-management.io
1.4.2.3. Query a single placementrule
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}1.4.2.3.1. Description
Query a single placementrule for more details.
1.4.2.3.2. Parameters
| Type | Name | Description | Schema | 
|---|---|---|---|
| Header | 
											COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string | 
| Path | 
											namespace | Namespace that you want to use, for example, default. | string | 
| Path | 
											placementrule_name | Name of the placementrule that you want to query. | string | 
1.4.2.3.3. Responses
| HTTP Code | Description | Schema | 
|---|---|---|
| 200 | Success | No Content | 
| 403 | Access forbidden | No Content | 
| 404 | Resource not found | No Content | 
| 500 | Internal service error | No Content | 
| 503 | Service unavailable | No Content | 
1.4.2.3.4. Tags
- placementrules.apps.open-cluster-management.io
1.4.2.4. Delete a placementrule
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}1.4.2.4.1. Parameters
| Type | Name | Description | Schema | 
|---|---|---|---|
| Header | 
											COOKIE | Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token. | string | 
| Path | 
											namespace | Namespace that you want to use, for example, default. | string | 
| Path | 
											placementrule_name | Name of the placementrule that you want to delete. | string | 
1.4.2.4.2. Responses
| HTTP Code | Description | Schema | 
|---|---|---|
| 200 | Success | No Content | 
| 403 | Access forbidden | No Content | 
| 404 | Resource not found | No Content | 
| 500 | Internal service error | No Content | 
| 503 | Service unavailable | No Content | 
1.4.2.4.3. Tags
- placementrules.apps.open-cluster-management.io
1.4.3. Definitions
1.4.3.1. Placementrule
| Name | Schema | 
|---|---|
| 
										apiVersion | string | 
| 
										kind | string | 
| 
										metadata | object | 
| 
										spec | 
spec
| Name | Schema | 
|---|---|
| 
										clusterConditions | < clusterConditions > array | 
| 
										clusterReplicas | integer | 
| 
										clusterSelector | |
| 
										clusters | < clusters > array | 
| 
										policies | < policies > array | 
| 
										resourceHint | |
| 
										schedulerName | string | 
clusterConditions
| Name | Schema | 
|---|---|
| 
										status | string | 
| 
										type | string | 
clusterSelector
| Name | Schema | 
|---|---|
| 
										matchExpressions | < matchExpressions > array | 
| 
										matchLabels | < string, string > map | 
matchExpressions
| Name | Schema | 
|---|---|
| 
										key | string | 
| 
										operator | string | 
| 
										values | < string > array | 
clusters
| Name | Schema | 
|---|---|
| 
										name | string | 
policies
| Name | Schema | 
|---|---|
| 
										apiVersion | string | 
| 
										fieldPath | string | 
| 
										kind | string | 
| 
										name | string | 
| 
										namespace | string | 
| 
										resourceVersion | string | 
| 
										uid | string | 
resourceHint
| Name | Schema | 
|---|---|
| 
										order | string | 
| 
										type | string |