Getting Information About Regions and Availability Zones

You can get information about Regions and Availability Zones (AZ) of the OUTSCALE Cloud, like their names or endpoints.

By default, the DescribeRegions method returns information about all Regions of the OUTSCALE Cloud. The DescribeAvailabilityZones method returns information about all the AZs in the Regions of your account. For more information, see Regions, Endpoints and Availability Zones Reference.

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

This feature is not available from Cockpit. This documentation only describes the procedure using AWS CLI.

Getting Information About Regions

To get information about one or more Regions, use the describe-regions command following this syntax:

Request sample
$ aws ec2 describe-regions \
    [--region-names NOT_SPECIFIED] \
    [--filters NOT_SPECIFIED] \
    --endpoint https://fcu.eu-west-2.outscale.com

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

  • (optional) region-names: The name of one or more Regions.

  • (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:

    • region-name: The name of the Region.

    • endpoint: The endpoint to access the Region.

      If you know only a string of the Region name or the endpoint, you can use it as value for the corresponding filters following this syntax:

      $ aws ec2 describe-regions \
         --filters "Name=region-name,Values=*xx*" \
      $ aws ec2 describe-regions \
         --filters "Name=endpoint,Values=*xx*" \
  • endpoint: The endpoint corresponding to the Region you want to send the request to.

The describe-regions command returns the following elements:

  • Regions: Information about one or more Regions. This element contains the following information:

    • Endpoint: The URL to access the Region.

    • RegionName: The name of the Region.

Result sample
{
    "Regions": [
        {
            "Endpoint": "fcu.eu-west-2.outscale.com",
            "RegionName": "eu-west-2"
        },
        {
            "Endpoint": "fcu.us-east-2.outscale.com",
            "RegionName": "us-east-2"
        },
        {
            "Endpoint": "fcu.us-west-1.outscale.com",
            "RegionName": "us-west-1"
        }
    ]
}

Getting Information About Availability Zones

You can use this command to get information about Availability Zones only in a Region for which you have an account. Otherwise, an error message is returned.

To get information about one or more Availability Zones inside a Region, use the describe-availability-zones command following this syntax:

Request sample
$ aws ec2 describe-availability-zones \
    --profile YOUR_PROFILE \
    [--zone-names NOT_SPECIFIED] \
    [--filters NOT_SPECIFIED] \
    --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.

  • (optional) zone-names: The name of one or more Availability Zones.

  • (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:

    • region-name: The name of the Region where the Availability Zones are located.

    • state: The current state of the Availability Zones ( available | information | impaired | unavailable ).

    • zone-name: The name of the Availability Zones.

  • endpoint: The endpoint corresponding to the Region you want to send the request to.

The describe-availability-zones command returns the following elements:

  • AvailabilityZones: Information about one or more Availability Zones. This element contains the following information for each Availability Zone:

    • State: The current state of the Availability Zone (always available).

    • RegionName: The name of the Region where the Availability Zone is located.

    • ZoneName: The name of the Availability Zone.

Result sample
{
    "AvailabilityZones": [
        {
            "State": "available",
            "RegionName": "eu-west-2",
            "ZoneName": "eu-west-2b"
        },
        {
            "State": "available",
            "RegionName": "eu-west-2",
            "ZoneName": "eu-west-2a"
        }
    ]
}

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.