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

Creating a Policy

Function

This API is used to create a policy.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{domain_id}/tenant/rule-sets/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Definition:

Tenant ID.

Constraints:

N/A

Value 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

Yes

Array of RequestRuleInstance objects

Definition:

Rule list.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 4 RequestRuleInstance

Parameter

Mandatory

Type

Description

id

No

String

Definition:

Rule instance 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 instance status.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

status

Boolean

Definition:

Whether the creation is successful.

Value range:

  • true: The creation is successful.

  • false: The creation fails.

rule_set_id

String

Definition:

Policy ID.

Value range:

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

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

POST https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/create

{
  "name" : "Creating a Policy - 20231020171008",
  "rules" : [ {
    "id" : "425eba0deaf04596a74cf7967d7fc04d",
    "is_valid" : true
  } ]
}

Example Responses

Status code: 200

OK

{
  "status" : true,
  "rule_set_id" : "9e0145159fdd49238aa1fcdd5b8239f9"
}

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.