Getting Information About Your Connections

You can get information about your connections located in the Region corresponding to your account.

Getting Information About Your Connections Using Cockpit v2

See the DirectLink dashboard.

Getting Information About Your Connections Using OSC CLI

The ReadDirectLinks command lists all DirectLinks in the Region.

Request sample
$ osc-cli api ReadDirectLinks --profile "default" \
    --Filters '{
        "DirectLinkIds": ["dxcon-12345678"]
      }'

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.

    • DirectLinkIds: (optional) The IDs of the DirectLinks.

  • 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 ReadDirectLinks command returns the following elements:

  • DirectLinks: Information about one or more DirectLinks.

    • AccountId: The account ID of the owner of the DirectLink.

    • Bandwidth: The physical link bandwidth (either 1 Gbps or 10 Gbps).

    • DirectLinkId: The ID of the DirectLink (for example, dxcon-xxxxxxxx).

    • DirectLinkName: The name of the DirectLink.

    • Location: The datacenter where the DirectLink is located.

    • RegionName: The Region in which the DirectLink has been created.

    • State: The state of the DirectLink.

  • requested: The DirectLink is requested but the request has not been validated yet.

  • pending: The DirectLink request has been validated. It remains in the pending state until you establish the physical link.

  • available: The physical link is established and the connection is ready to use.

  • deleting: The deletion process is in progress.

  • deleted: The DirectLink is deleted.

  • 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.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "DirectLinks": [
    {
      "AccountId": "123456789012",
      "Bandwidth": "1Gbps",
      "DirectLinkId": "dxcon-12345678",
      "DirectLinkName": "Connection to Outscale",
      "Location": "PAR1",
      "RegionName": "eu-west-2",
      "State": "available"
    }
  ]
}

Getting Information About Your Connections Using oapi-cli

The ReadDirectLinks command lists all DirectLinks in the Region.

Request sample
$ oapi-cli --profile "default" ReadDirectLinks \
    --Filters '{
        "DirectLinkIds": ["dxcon-12345678"]
      }'

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.

    • DirectLinkIds: (optional) The IDs of the DirectLinks.

  • 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 ReadDirectLinks command returns the following elements:

  • DirectLinks: Information about one or more DirectLinks.

    • AccountId: The account ID of the owner of the DirectLink.

    • Bandwidth: The physical link bandwidth (either 1 Gbps or 10 Gbps).

    • DirectLinkId: The ID of the DirectLink (for example, dxcon-xxxxxxxx).

    • DirectLinkName: The name of the DirectLink.

    • Location: The datacenter where the DirectLink is located.

    • RegionName: The Region in which the DirectLink has been created.

    • State: The state of the DirectLink.

  • requested: The DirectLink is requested but the request has not been validated yet.

  • pending: The DirectLink request has been validated. It remains in the pending state until you establish the physical link.

  • available: The physical link is established and the connection is ready to use.

  • deleting: The deletion process is in progress.

  • deleted: The DirectLink is deleted.

  • 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.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "DirectLinks": [
    {
      "AccountId": "123456789012",
      "Bandwidth": "1Gbps",
      "DirectLinkId": "dxcon-12345678",
      "DirectLinkName": "Connection to Outscale",
      "Location": "PAR1",
      "RegionName": "eu-west-2",
      "State": "available"
    }
  ]
}

Getting Information About Your Connections Using AWS CLI

Before you begin: Install and configure AWS CLI. For more information, see Installing and Configuring AWS CLI.

To get information about your connections, use the describe-connections command following this syntax:

Request sample
$ aws directconnect describe-connections \
    --profile YOUR_PROFILE \
    --connection-id dxcon-12345678 \
    --endpoint https://directlink.eu-west-2.outscale.com

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

  • (optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.

  • (optional) connection-id: The ID of a connection.

    If you do not specify any connection ID, all your connections in the Region corresponding to your account are described.

  • endpoint: The endpoint corresponding to the Region you want to send the request to. For more information, see Installing and Configuring AWS CLI.

The describe-connections command returns the following elements:

  • connections: Information about one or more connections. This element contains the following information for each connection:

    • ownerAccount: The account ID of the owner of the requested connection.

    • connectionID: The ID of the connection.

    • connectionState: The state of the connection. For more information, see About DirectLink > DirectLink Physical Connections.

    • bandwidth: The bandwidth for the connection.

    • location: The location of the connection.

    • connectionName: The name of the connection.

    • region: The Region where the connection is.

Result sample
{
    "connections": [
        {
            "ownerAccount": "123456789012",
            "connectionId": "dxcon-12345678",
            "connectionState": "requested",
            "bandwidth": "1Gbps",
            "location": "PAR1",
            "connectionName": "Connection to Outscale",
            "region": "eu-west-2"
        }
    ]
}

Related Pages

Corresponding API Methods

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.

Export to PDF