Updated on 2023-11-23 GMT+08:00

Disabling a Rule

Function

This API is used to disable a rule.

URI

POST /v2/{project_id}/routemgr/rules/{rule_id}/stop

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

rule_id

Yes

String

Rule ID.

Request

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

The default value application/json is recommended.

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response

When the status code is 400, the response parameters are as follows:

Table 3 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_message

String

Error message.

When the status code is 401, the response parameters are as follows.

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_message

String

Error message.

When the status code is 500, the response parameters are as follows:

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_message

String

Error message.

Example Request

None

Example Response

None

Status Codes

Status Code

Description

201

Disabled.

400

Error response.

401

Error response.

500

Error response.

Error Codes

For details, see Error Codes.