Getting Information About Your Net Access Points

You can get information about one or more of your Net access points, like the name of the targeted service or the Net in which it is.

Getting Information About Your Net Access Points Using Cockpit v2

See the Net Access Points dashboard.

Getting Information About Your Net Access Points Using OSC CLI

The ReadNetAccessPoints command lists one or more Net access points.

Request sample
$ osc-cli api ReadNetAccessPoints --profile "default" \
    --Filters '{
        "NetAccessPointIds": ["vpce-12345678"]
      }'
Request sample
$ osc-cli api ReadNetAccessPoints --profile "default" \
    --Filters '{
        "NetIds": ["vpc-12345678"],
        "States": ["available"]
      }'

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.

    • NetAccessPointIds: (optional) The IDs of the Net access points.

    • NetIds: (optional) The IDs of the Nets.

    • ServiceNames: (optional) The names of the services. For more information, see ReadNetAccessPointServices.

    • States: (optional) The states of the Net access points (pending | available | deleting | deleted).

    • TagKeys: (optional) The keys of the tags associated with the Net access points.

    • TagValues: (optional) The values of the tags associated with the Net access points.

    • Tags: (optional) The key/value combination of the tags associated with the Net access points, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

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

  • NetAccessPoints: One or more Net access points.

    • NetAccessPointId: The ID of the Net access point.

    • NetId: The ID of the Net with which the Net access point is associated.

    • RouteTableIds: The ID of the route tables associated with the Net access point.

    • ServiceName: The name of the service with which the Net access point is associated.

    • State: The state of the Net access point (pending | available | deleting | deleted).

    • Tags: One or more tags associated with the Net access point.

      • Key: The key of the tag, with a minimum of 1 character.

      • Value: The value of the tag, between 0 and 255 characters.

  • 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"
  },
  "NetAccessPoints": [
    {
      "Tags": [],
      "NetAccessPointId": "vpce-12345678",
      "RouteTableIds": [
        "rtb-12345678"
      ],
      "State": "available",
      "NetId": "vpc-12345678",
      "ServiceName": "com.outscale.eu-west-2.oos"
    }
  ]
}

Getting Information About Your Net Access Points Using oapi-cli

The ReadNetAccessPoints command lists one or more Net access points.

Request sample
$ oapi-cli --profile "default" ReadNetAccessPoints \
    --Filters '{
        "NetAccessPointIds": ["vpce-12345678"]
      }'
Request sample
$ oapi-cli --profile "default" ReadNetAccessPoints \
    --Filters '{
        "NetIds": ["vpc-12345678"],
        "States": ["available"]
      }'

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.

    • NetAccessPointIds: (optional) The IDs of the Net access points.

    • NetIds: (optional) The IDs of the Nets.

    • ServiceNames: (optional) The names of the services. For more information, see ReadNetAccessPointServices.

    • States: (optional) The states of the Net access points (pending | available | deleting | deleted).

    • TagKeys: (optional) The keys of the tags associated with the Net access points.

    • TagValues: (optional) The values of the tags associated with the Net access points.

    • Tags: (optional) The key/value combination of the tags associated with the Net access points, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

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

  • NetAccessPoints: One or more Net access points.

    • NetAccessPointId: The ID of the Net access point.

    • NetId: The ID of the Net with which the Net access point is associated.

    • RouteTableIds: The ID of the route tables associated with the Net access point.

    • ServiceName: The name of the service with which the Net access point is associated.

    • State: The state of the Net access point (pending | available | deleting | deleted).

    • Tags: One or more tags associated with the Net access point.

      • Key: The key of the tag, with a minimum of 1 character.

      • Value: The value of the tag, between 0 and 255 characters.

  • 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"
  },
  "NetAccessPoints": [
    {
      "Tags": [],
      "NetAccessPointId": "vpce-12345678",
      "RouteTableIds": [
        "rtb-12345678"
      ],
      "State": "available",
      "NetId": "vpc-12345678",
      "ServiceName": "com.outscale.eu-west-2.oos"
    }
  ]
}

Getting Information About Your VPC Endpoints Using AWS CLI

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

To get information about one or more of your VPC endpoints, use the describe-vpc-endpoints command following this syntax:

Request sample
$ aws ec2 describe-vpc-endpoint \
    --profile YOUR_PROFILE \
    --vpc-endpoint-ids vpce-12345678 \
    --filters Name=X,Values=Y \
    --endpoint https://fcu.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.

  • vpc-endpoints-ids: One or more IDs of VPC endpoints.

  • (optional) filters: One or more filters, in the "Name=X,Values=Y" format.

    You can specify several values for a same filter using the "Name=X,Values=Y, Z" format.

    The following filters are available:

    • service-name: The name of the prefix list corresponding to the service. For more information, see Getting Information About Prefix Lists.

    • vpc-id: The ID of the VPC.

    • vpc-endpoint-id: The ID of the VPC endpoint.

    • vpc-endpoint-state: The state of the VPC endpoint (pending | available). For more information, see About Net Access Points.

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

  • VpcEndpoints: Information about one or more VPC endpoints. This element contains the following information:

    • VpcId: The ID of the VPC in which the VPC endpoint is.

    • State: The state of the VPC endpoint. For more information, see About Net Access Points.

    • ServiceName: The name of the prefix list corresponding to the service.

    • RouteTableIds: One or more IDs of route tables routing traffic to the service using the VPC endpoint.

    • VpcEndpointId: The ID of the VPC endpoint.

    • CreationTimestamp: The date and time of creation of the VPC endpoint.

Result sample
{
  "VpcEndpoints": [
                   {
                    "VpcId": "vpc-1234abcd",
                    "State": "available",
                    "ServiceName": "com.outscale.eu-west-2.oos",
                    "RouteTableIds": [
                                      "rtb-87654321"
                                     ],
                    "VpcEndpointId": "vpce-12345678",
                    "CreationTimestamp": "2016-10-16T17:02:42Z"
                   }
                  ]
}

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