Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ APIs/ Defining Custom Document Parsing Rules/ Deleting Custom Parsing Rules
Updated on 2025-08-13 GMT+08:00
View PDF
Share

Deleting Custom Parsing Rules

Function

This API is used to delete a user-defined parsing rule.

URI

DELETE /v1/{project_id}/applications/{application_id}/uni-search/rule-regex/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

application_id

Yes

String

Definition:

Application ID. For details about how to obtain the application ID, see Obtaining an Application ID.

Constraints:

Character string

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

id

Yes

String

Definition:

User-defined rule ID.

Constraints:

N/A

Value range:

The value can contain 1 to 64 characters. It can only contain letters, digits, underscores (_), and hyphens (-).

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

Token used for API authentication. For details about how to obtain the token, see Obtaining an IAM User Token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Definition:

ID of the rule to be deleted.

Value range:

N/A

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

None

Example Responses

Status code: 200

Deleted.

{
  "id" : "1777619994213965826"
}

Status Codes

Status Code

Description

200

Deleted.

400

Incorrect request body parameter.

500

Internal error.

Error Codes

See Error Codes.