Modifier une listener rule

Vous pouvez modifier une listener rule que vous avez créée.

Cette action met à jour la règle de la listener rule spécifiée pour distribuer le trafic aux machines virtuelles (VM) backend enregistrées. Tout attribut que vous ne mettez pas à jour garde sa valeur actuelle.

Pour afficher la règle ou les VM enregistrées de votre listener rule, voir Obtenir des informations sur vos listener rules.

À la création d’une listener rule, vous devez enregistrer toutes les backends cibles. Pour modifier la liste des VM backend d’une listener rule, vous devez supprimer la règle et en créer une nouvelle.

Modifier une listener rule avec OSC CLI

À ce jour, cette section est disponible en anglais uniquement.

The UpdateListenerRule command updates the pattern of the listener rule.
This call updates the pattern matching algorithm for incoming traffic.

Request sample
$ osc-cli api UpdateListenerRule --profile "default" \
    --ListenerRuleName "example-listener-rule" \
    --HostPattern "*.newhost.com"

This command contains the following attributes that you need to specify:

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • HostPattern: (optional) A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except -.?.

  • ListenerRuleName: The name of the listener rule.

  • PathPattern: (optional) A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except _-.$/~"'@:+?.

The UpdateListenerRule command returns the following elements:

  • ListenerRule: Information about the listener rule.

    • Action: The type of action for the rule (always forward).

    • HostNamePattern: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except -.?.

    • ListenerId: The ID of the listener.

    • ListenerRuleId: The ID of the listener rule.

    • ListenerRuleName: A human-readable name for the listener rule.

    • PathPattern: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except _-.$/~"'@:+?.

    • Priority: The priority level of the listener rule, between 1 and 19999 both included. Each rule must have a unique priority level. Otherwise, an error is returned.

    • VmIds: The IDs of the backend VMs.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "ListenerRule": {
    "Priority": 10,
    "VmIds": [
      "i-12345678"
    ],
    "ListenerRuleName": "example-listener-rule",
    "Action": "forward",
    "ListenerId": 123456,
    "HostNamePattern": "*.newhost.com",
    "ListenerRuleId": 1234
  }
}

Modifier une listener rule avec oapi-cli

À ce jour, cette section est disponible en anglais uniquement.

The UpdateListenerRule command updates the pattern of the listener rule.
This call updates the pattern matching algorithm for incoming traffic.

Request sample
$ oapi-cli --profile "default" UpdateListenerRule \
    --ListenerRuleName "example-listener-rule" \
    --HostPattern "*.newhost.com"

This command contains the following attributes that you need to specify:

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • HostPattern: (optional) A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except -.?.

  • ListenerRuleName: The name of the listener rule.

  • PathPattern: (optional) A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except _-.$/~"'@:+?.

The UpdateListenerRule command returns the following elements:

  • ListenerRule: Information about the listener rule.

    • Action: The type of action for the rule (always forward).

    • HostNamePattern: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except -.?.

    • ListenerId: The ID of the listener.

    • ListenerRuleId: The ID of the listener rule.

    • ListenerRuleName: A human-readable name for the listener rule.

    • PathPattern: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except _-.$/~"'@:+?.

    • Priority: The priority level of the listener rule, between 1 and 19999 both included. Each rule must have a unique priority level. Otherwise, an error is returned.

    • VmIds: The IDs of the backend VMs.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "ListenerRule": {
    "Priority": 10,
    "VmIds": [
      "i-12345678"
    ],
    "ListenerRuleName": "example-listener-rule",
    "Action": "forward",
    "ListenerId": 123456,
    "HostNamePattern": "*.newhost.com",
    "ListenerRuleId": 1234
  }
}

Pages connexes

Méthodes API correspondantes