Updates a ruleset - Elasticsearch API

Updates the ruleset with the definition.

curl --location --request PUT 'http://127.0.0.1/deployments/traffic-filter/rulesets/' \ --header 'Authorization: ApiKey {{EC_API_KEY}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "string", "rules": [ { "azure_endpoint_name": "string", "egress_rule": { "protocol": "all", "target": "string", "ports": [ 0 ] }, "description": "string", "source": "string", "azure_endpoint_guid": "string", "id": "string" } ], "region": "string", "include_by_default": true, "type": "string", "description": "string" }'

请求参数

Path 参数

ruleset_id

必需

The mandatory ruleset ID.

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

Body 参数application/json

The specification for traffic filter ruleset.

name

string

必需

Name of the ruleset

rules

array[object (TrafficFilterRule) {6}]

必需

List of rules

azure_endpoint_name

string

可选

Name of the Azure Private Endpoint to allow connections from

egress_rule

object (TrafficFilterEgressRule)

可选

The rule detail for a traffic filter egress rule.

description

string

可选

Description of the rule

source

string

可选

Allowed traffic filter source: IP address, CIDR mask, or VPC endpoint ID

azure_endpoint_guid

string

可选

Resource GUID of the Azure Private Endpoint to allow connections from

string

可选

The rule ID

region

string

必需

The ruleset can be attached only to deployments in the specific region

include_by_default

boolean

必需

Should the ruleset be automatically included in the new deployments

type

string

必需

Type of the ruleset

description

string

可选

Description of the ruleset

示例

返回响应

🟢200The ruleset definition was valid and the update has started.

application/json

Body

The response after you create a new ruleset.

string

必需

The new ruleset ID

🟠404The traffic filter ruleset specified by {ruleset_id} cannot be found. (code: `traffic_filter.not_found`)

🔴500Error reading the traffic filter ruleset. (code: `traffic_filter.request_execution_failed`)