Help Center/ CodeArts Pipeline/ API Reference (Ally Region)/ API/ Tenant-Level Policy Management/ Modifying a Policy
Updated on 2026-01-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying a Policy

Function

This API is used to modify a policy.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{domain_id}/tenant/rule-sets/{rule_set_id}/update

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

rule_set_id

Yes

String

Definition:

Policy ID, which is the unique identifier of a policy. Obtain the policy ID by calling the API for querying policies. data.id indicates the policy ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

domain_id

Yes

String

Definition:

Tenant ID, that is, domain ID of a user.

Constraints:

N/A

Range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for .

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition:

Policy name.

Constraints:

The policy name can contain only letters, digits, hyphens (-), and underscores (_).

Value range:

Enter a maximum of 128 characters.

Default value:

N/A

rules

No

Array of UpdateRuleInstance objects

Definition:

Rules in a policy.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 4 UpdateRuleInstance

Parameter

Mandatory

Type

Description

id

No

String

Definition:

Rule ID, which is the unique identifier of a rule. Obtain the rule ID by calling the API for obtaining rules by page. data.id indicates the rule ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

is_valid

No

Boolean

Definition:

Rule status.

Constraints:

N/A

Value range:

  • true: enabled.

  • false: disabled.

Default value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

status

Boolean

Definition:

Whether the calling is successful.

Value range:

  • true: The calling is successful.

  • false: The calling fails.

rule_set_id

String

Definition:

Policy ID, which is the unique identifier of a policy. Obtain the policy ID by calling the API for querying policies. data.id indicates the policy ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

Example Requests

PUT https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/update

{
  "name" : "Create a tenant-level policy.",
  "rules" : [ {
    "id" : "097f315044244c9193f1e3f1fba7979d",
    "is_valid" : true
  }, {
    "id" : "80cfcff078074b8aa7951d7b67b3137b",
    "is_valid" : true
  } ]
}

Example Responses

Status code: 200

OK

{
  "status" : true,
  "rule_set_id" : "6cb18ee5ca1c48caa335706e0e5ee288"
}

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.