Help Center/ Ubiquitous Cloud Native Service/ API Reference/ API/ UCS Cluster/ Creating a Cluster Policy Instance
Updated on 2025-12-01 GMT+08:00

Creating a Cluster Policy Instance

Function

This API is used to create a cluster policy instance.

URI

POST /v1/clusters/{clusterid}/policyinstance

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

clusterid

Yes

String

Cluster ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Identity authentication information. Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

constraintTemplateID

No

String

Policy template ID

enforcementAction

No

String

Policy enforcement action. The options are warn and deny.

namespaces

No

Array of strings

Namespace

parameters

No

Object

Policy instance parameters

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

jobID

String

Job ID

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

-

String

-

Example Requests

Creating a cluster policy instance

POST https://ucs.myhuaweicloud.com/v1/clustergroups/{clustergroupid}/policyinstance

{
  "enforcementAction" : "deny",
  "namespaces" : [ "default" ],
  "parameters" : {
    "exemptImages" : [ "test" ],
    "procMount" : "Default"
  },
  "constraintTemplateID" : "f14d4210-adf8-11ed-9f9c-0255ac100186"
}

Example Responses

Status code: 201

ID of the job for creating a policy instance returned

{
  "jobID" : "ae4e4da4-92f7-48c9-822d-6a9978d30d16"
}

Status Codes

Status Code

Description

201

ID of the job for creating a policy instance returned

400

Client request error. The server could not execute the request.

404

Resources not found

500

Internal server error

Error Codes

See Error Codes.