Obtenir des informations sur vos virtual gateways (DirectLink)

Vous pouvez obtenir des informations à propos de vos virtual gateways que vous pouvez utiliser comme cible pour une ou plusieurs virtual interfaces. La virtual gateway doit être à l’état available et attachée au Net auquel vous souhaitez accéder.

Obtenir des informations sur vos virtual gateways (DirectLink) avec Cockpit v2

Voir le dashboard DirectLink Interfaces.

Obtenir des informations sur vos virtual gateways (DirectLink) avec OSC CLI

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

The ReadVirtualGateways command lists one or more virtual gateways.

Request sample

$ osc-cli api ReadVirtualGateways --profile "default" \
    --Filters '{
        "VirtualGatewayIds": ["vgw-12345678"]
      }'

Request sample

$ osc-cli api ReadVirtualGateways --profile "default" \
    --Filters '{
        "States": ["available"],
        "LinkStates": ["attached", "detached"]
      }'

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.
Filters: (optional) One or more filters.
- ConnectionTypes: (optional) The types of the virtual gateways (always ipsec.1).
- LinkNetIds: (optional) The IDs of the Nets the virtual gateways are attached to.
- LinkStates: (optional) The current states of the attachments between the virtual gateways and the Nets (attaching | attached | detaching | detached).
- States: (optional) The states of the virtual gateways (pending | available | deleting | deleted).
- TagKeys: (optional) The keys of the tags associated with the virtual gateways.
- TagValues: (optional) The values of the tags associated with the virtual gateways.
- Tags: (optional) The key/value combination of the tags associated with the virtual gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
- VirtualGatewayIds: (optional) The IDs of the virtual gateways.
NextPageToken: (optional) The token to request the next page of results. Each token refers to a specific page.
ResultsPerPage: (optional) The maximum number of logs returned in a single response (between 1 and 1000, both included). By default, 100.

The ReadVirtualGateways command returns the following elements:

NextPageToken: The token to request the next page of results. Each token refers to a specific page.
ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
VirtualGateways: Information about one or more virtual gateways.
- ConnectionType: The type of VPN connection supported by the virtual gateway (always ipsec.1).
- NetToVirtualGatewayLinks: The Net to which the virtual gateway is attached.
  - NetId: The ID of the Net to which the virtual gateway is attached.
  - State: The state of the attachment (attaching | attached | detaching | detached).
- State: The state of the virtual gateway (pending | available | deleting | deleted).
- Tags: One or more tags associated with the virtual gateway.
  - Key: The key of the tag, with a minimum of 1 character.
  - Value: The value of the tag, between 0 and 255 characters.
- VirtualGatewayId: The ID of the virtual gateway.

Result sample

{
  "VirtualGateways": [
    {
      "VirtualGatewayId": "vgw-12345678",
      "ConnectionType": "ipsec.1",
      "NetToVirtualGatewayLinks": [],
      "State": "available",
      "Tags": []
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Result sample

{
  "VirtualGateways": [
    {
      "VirtualGatewayId": "vgw-12345678",
      "ConnectionType": "ipsec.1",
      "NetToVirtualGatewayLinks": [
        {
          "State": "attached",
          "NetId": "vpc-12345678"
        }
      ],
      "State": "available",
      "Tags": []
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Obtenir des informations sur vos virtual gateways (DirectLink) avec oapi-cli

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

The ReadVirtualGateways command lists one or more virtual gateways.

Request sample

$ oapi-cli --profile "default" ReadVirtualGateways \
    --Filters '{
        "VirtualGatewayIds": ["vgw-12345678"]
      }'

Request sample

$ oapi-cli --profile "default" ReadVirtualGateways \
    --Filters '{
        "States": ["available"],
        "LinkStates": ["attached", "detached"]
      }'

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.
Filters: (optional) One or more filters.
- ConnectionTypes: (optional) The types of the virtual gateways (always ipsec.1).
- LinkNetIds: (optional) The IDs of the Nets the virtual gateways are attached to.
- LinkStates: (optional) The current states of the attachments between the virtual gateways and the Nets (attaching | attached | detaching | detached).
- States: (optional) The states of the virtual gateways (pending | available | deleting | deleted).
- TagKeys: (optional) The keys of the tags associated with the virtual gateways.
- TagValues: (optional) The values of the tags associated with the virtual gateways.
- Tags: (optional) The key/value combination of the tags associated with the virtual gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
- VirtualGatewayIds: (optional) The IDs of the virtual gateways.
NextPageToken: (optional) The token to request the next page of results. Each token refers to a specific page.
ResultsPerPage: (optional) The maximum number of logs returned in a single response (between 1 and 1000, both included). By default, 100.

The ReadVirtualGateways command returns the following elements:

NextPageToken: The token to request the next page of results. Each token refers to a specific page.
ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
VirtualGateways: Information about one or more virtual gateways.
- ConnectionType: The type of VPN connection supported by the virtual gateway (always ipsec.1).
- NetToVirtualGatewayLinks: The Net to which the virtual gateway is attached.
  - NetId: The ID of the Net to which the virtual gateway is attached.
  - State: The state of the attachment (attaching | attached | detaching | detached).
- State: The state of the virtual gateway (pending | available | deleting | deleted).
- Tags: One or more tags associated with the virtual gateway.
  - Key: The key of the tag, with a minimum of 1 character.
  - Value: The value of the tag, between 0 and 255 characters.
- VirtualGatewayId: The ID of the virtual gateway.

Result sample

{
  "VirtualGateways": [
    {
      "VirtualGatewayId": "vgw-12345678",
      "ConnectionType": "ipsec.1",
      "NetToVirtualGatewayLinks": [],
      "State": "available",
      "Tags": []
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Result sample

{
  "VirtualGateways": [
    {
      "VirtualGatewayId": "vgw-12345678",
      "ConnectionType": "ipsec.1",
      "NetToVirtualGatewayLinks": [
        {
          "State": "attached",
          "NetId": "vpc-12345678"
        }
      ],
      "State": "available",
      "Tags": []
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Obtenir des informations sur vos virtual private gateways (DirectLink) avec AWS CLI

Avant de commencer : Installez et configurez AWS CLI. Pour en savoir plus, voir Installer et configurer AWS CLI.

Pour obtenir des informations à propos de vos virtual private gateways, utilisez la commande describe-virtual-gateways en suivant cette syntaxe :

Exemple de requête

$ aws directconnect describe-virtual-gateways \
    --profile YOUR_PROFILE \
    --endpoint https://directlink.eu-west-2.outscale.com

Cette commande contient les attributs suivants que vous devez spécifier :

(optionnel) profile : Le profil nommé que vous voulez utiliser, créé pendant la configuration d’AWS CLI. Pour en savoir plus, voir Installer et configurer AWS CLI.
endpoint : Le endpoint correspondant à la Région à laquelle vous voulez envoyer la requête. Pour en savoir plus, voir Installer et configurer AWS CLI.

La commande describe-virtual-gateways renvoie les éléments suivants :

virtualGateways : Informations à propos d’une ou plusieurs virtual private gateways. Cet élément contient les informations suivantes :
- virtualGatewayId : L’ID de la virtual private gateway.
- virtualGatewayState : L’état de la virtual private gateway (pending | available | deleting | deleted).

Exemple de résultat

{
    "virtualGateways": [
        {
            "virtualGatewayId": "vgw-87654321",
            "virtualGatewayState": "available"
        }
    ]
}

Pages connexes

Méthodes API correspondantes

AWS™ et Amazon Web Services™ sont des marques de commerce d'Amazon Technologies, Inc. ou de ses affiliées aux États-Unis et/ou dans les autres pays.