List traffic filter rulesets

开发环境

http://127.0.0.1

GET

/deployments/traffic-filter/rulesets

DeploymentsTrafficFilter

List all of the traffic filter rulesets.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://127.0.0.1/deployments/traffic-filter/rulesets' \
--header 'Authorization: ApiKey {{EC_API_KEY}}'

响应示例

200 - 示例 1

{
    "rulesets": [
        {
            "associations": [
                {
                    "id": "string",
                    "entity_type": "string"
                }
            ],
            "description": "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,
            "total_associations": 0,
            "type": "string",
            "id": "string",
            "name": "string"
        }
    ]
}

请求参数

Query 参数

include_associations

可选

Retrieves a list of resources that are associated to the specified ruleset.

region

可选

If provided limits the rulesets to that region only.

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

返回响应

🟢200The collection of traffic filter routes

application/json

Body

The container for a set of traffic filter rulesets.

rulesets

array[object (TrafficFilterRulesetInfo) {9}]

必需

List of traffic filter rules

associations

array[object (FilterAssociation) {2}]

可选

List of associations. Returned only when include_associations query parameter is true

description

string

可选

Description of the ruleset

rules

array[object (TrafficFilterRule) {6}]

必需

List of rules

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

total_associations

integer <int32>

可选

Total number of associations. This includes associations the user does not have permission to view.Returned only when include_associations query parameter is true

type

string

必需

Type of the ruleset

string

必需

The ruleset ID

name

string

必需

Name of the ruleset

🔴500Error fetching traffic filter rulesets. (code: `traffic_filter.request_execution_failed`)

Create a ruleset

Get associated rulesets