Get load balancer L7 policy

GET /cloud/v1/l7policies/{project_id}/{region_id}/{l7policy_id}

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
load_balancer_l7_policy = client.cloud.load_balancers.l7_policies.get(
    l7policy_id="023f2e34-7806-443b-bfae-16c324569a3d",
    project_id=1,
    region_id=1,
)
print(load_balancer_l7_policy.id)

200

{
  "action": "REDIRECT_TO_URL",
  "id": "9b4b9a23-ccac-4945-bcdd-b0e793c12cd9",
  "listener_id": "023f2e34-7806-443b-bfae-16c324569a3d",
  "name": "redirect-example.com",
  "operating_status": "ONLINE",
  "position": 1,
  "project_id": 1337,
  "provisioning_status": "ACTIVE",
  "redirect_http_code": 301,
  "redirect_pool_id": "00000000-0000-4000-8000-000000000000",
  "redirect_prefix": "<string>",
  "redirect_url": "<string>",
  "region": "Luxembourg 1",
  "region_id": 7,
  "rules": [
    {
      "id": "0ca7bebd-7a54-4977-bca7-e4ac1e612ec7",
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7
    }
  ],
  "tags": [
    "test_tag"
  ],
  "task_id": "023f2e34-7806-443b-bfae-16c324569a3d"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

project_id · integer · required

Project ID

Example:

1

region_id · integer · required

Region ID

Example:

1

l7policy_id · string<uuid4> · required

L7 policy ID

Example:

"023f2e34-7806-443b-bfae-16c324569a3d"

Response

200

application/json

L7 policy

action · enum<string> · required

Action

Available options: REDIRECT_PREFIX, REDIRECT_TO_POOL, REDIRECT_TO_URL, REJECT

Example:

"REDIRECT_TO_URL"

id · string · required

ID

Example:

"9b4b9a23-ccac-4945-bcdd-b0e793c12cd9"

listener_id · string · required

Listener ID

Example:

"023f2e34-7806-443b-bfae-16c324569a3d"

name · string · required

Human-readable name of the policy

Example:

"redirect-example.com"

operating_status · enum<string> · required

L7 policy operating status

Available options: DEGRADED, DRAINING, ERROR, NO_MONITOR, OFFLINE, ONLINE

Example:

"ONLINE"

position · integer · required

The position of this policy on the listener. Positions start at 1.

Example:

1

project_id · integer · required

Project ID

Example:

1337

provisioning_status · enum<string> · required

Available options: ACTIVE, DELETED, ERROR, PENDING_CREATE, PENDING_DELETE, PENDING_UPDATE

Example:

"ACTIVE"

redirect_http_code · integer | null · required

Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if action is REDIRECT_TO_URL or REDIRECT_PREFIX. Valid options are 301, 302, 303, 307, or 308. Default is 302.

Example:

301

redirect_pool_id · string | null · required

Requests matching this policy will be redirected to the pool with this ID. Only valid if action is REDIRECT_TO_POOL.

Example:

"00000000-0000-4000-8000-000000000000"

redirect_prefix · string | null · required

Requests matching this policy will be redirected to this Prefix URL. Only valid if action is REDIRECT_PREFIX.

redirect_url · string | null · required

Requests matching this policy will be redirected to this URL. Only valid if action is REDIRECT_TO_URL.

region · string · required

Region name

Example:

"Luxembourg 1"

region_id · integer · required

Region ID

Example:

7

rules · L7RuleInlineSerializer · object[] · required

Rules. All the rules associated with a given policy are logically ANDed together. A request must match all the policy's rules to match the policy.If you need to express a logical OR operation between rules, then do this by creating multiple policies with the same action.

Show child attributes

tags · string[] · required

A list of simple strings assigned to the resource.

Example:

["test_tag"]

task_id · string<uuid4> | null · required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

"023f2e34-7806-443b-bfae-16c324569a3d"