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}/placementrules
1.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}/placementrules
1.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 |