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
Copy to Clipboard Toggle word wrap
1.4.2.1.1. Description

Create a placementrule.

1.4.2.1.2. Parameters
Expand
TypeNameDescriptionSchema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Path

namespace
required

Namespace that you want to use, for example, default.

string

Body

body
required

Parameters describing the placementrule to be created.

Placementrule

1.4.2.1.3. Responses
Expand
HTTP CodeDescriptionSchema

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
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "PlacementRule",
  "metadata" : {
    "name" : "towhichcluster",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "clusterConditions" : [ {
      "type": "ManagedClusterConditionAvailable",
      "status": "True"
    } ],
    "clusterSelector" : { }
  }
}
Copy to Clipboard Toggle word wrap

1.4.2.2. Query all placementrules

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
Copy to Clipboard Toggle word wrap
1.4.2.2.1. Description

Query your placementrules for more details.

1.4.2.2.2. Parameters
Expand
TypeNameDescriptionSchema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Path

namespace
required

Namespace that you want to use, for example, default.

string

1.4.2.2.3. Responses
Expand
HTTP CodeDescriptionSchema

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}
Copy to Clipboard Toggle word wrap
1.4.2.3.1. Description

Query a single placementrule for more details.

1.4.2.3.2. Parameters
Expand
TypeNameDescriptionSchema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Path

namespace
required

Namespace that you want to use, for example, default.

string

Path

placementrule_name
required

Name of the placementrule that you want to query.

string

1.4.2.3.3. Responses
Expand
HTTP CodeDescriptionSchema

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}
Copy to Clipboard Toggle word wrap
1.4.2.4.1. Parameters
Expand
TypeNameDescriptionSchema

Header

COOKIE
required

Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.

string

Path

namespace
required

Namespace that you want to use, for example, default.

string

Path

placementrule_name
required

Name of the placementrule that you want to delete.

string

1.4.2.4.2. Responses
Expand
HTTP CodeDescriptionSchema

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

Expand
NameSchema

apiVersion
required

string

kind
required

string

metadata
required

object

spec
required

spec

spec

Expand
NameSchema

clusterConditions
optional

< clusterConditions > array

clusterReplicas
optional

integer

clusterSelector
optional

clusterSelector

clusters
optional

< clusters > array

policies
optional

< policies > array

resourceHint
optional

resourceHint

schedulerName
optional

string

clusterConditions

Expand
NameSchema

status
optional

string

type
optional

string

clusterSelector

Expand
NameSchema

matchExpressions
optional

< matchExpressions > array

matchLabels
optional

< string, string > map

matchExpressions

Expand
NameSchema

key
optional

string

operator
optional

string

values
optional

< string > array

clusters

Expand
NameSchema

name
optional

string

policies

Expand
NameSchema

apiVersion
optional

string

fieldPath
optional

string

kind
optional

string

name
optional

string

namespace
optional

string

resourceVersion
optional

string

uid
optional

string

resourceHint

Expand
NameSchema

order
optional

string

type
optional

string

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat