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

Deleting a Rule

Function

This API is used to delete a rule.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{domain_id}/rules/{rule_id}/delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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

rule_id

Yes

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

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

Boolean

Definition:

Whether the deletion is successful.

Value range:

  • true: The deletion is successful.

  • false: The deletion fails.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_msg

String

Definition:

Error message.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_msg

String

Definition:

Error message.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_msg

String

Definition:

Error message.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_msg

String

Definition:

Error message.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Example Requests

DELETE https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/2965ed53fe804115816b781ab20fef3c/delete

Example Responses

Status code: 200

Request succeeded.

{
  "status" : true
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

Authentication failed.

403

No permission.

404

Resource not found.

Error Codes

See Error Codes.

Parent topic: Rule Management