Getting Information About Regions

You can get information about the Regions of the OUTSCALE Cloud.

However, at this time the API does not necessarily return all the public Regions that are available. For a full list, see About Regions and Subregions.

Getting Information About Regions Using OSC CLI

The ReadRegions command lists one or more Regions of the OUTSCALE Cloud.

For more information, see About Regions and Subregions.

Request sample
$ osc-cli api ReadRegions --profile "default"

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.

The ReadRegions command returns the following elements:

  • Regions: Information about one or more Regions.

    • Endpoint: The hostname of the gateway to access the Region.

    • RegionName: The administrative name of the Region.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Regions": [
    {
      "RegionName": "eu-west-2",
      "Endpoint": "api.eu-west-2.outscale.com"
    },
    {
      "RegionName": "us-east-2",
      "Endpoint": "api.us-east-2.outscale.com"
    },
    {
      "RegionName": "us-west-1",
      "Endpoint": "api.us-west-1.outscale.com"
    }
  ]
}

Getting Information About Regions Using oapi-cli

The ReadRegions command lists one or more Regions of the OUTSCALE Cloud.

For more information, see About Regions and Subregions.

Request sample
$ oapi-cli --profile "default" ReadRegions

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.

The ReadRegions command returns the following elements:

  • Regions: Information about one or more Regions.

    • Endpoint: The hostname of the gateway to access the Region.

    • RegionName: The administrative name of the Region.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Regions": [
    {
      "RegionName": "eu-west-2",
      "Endpoint": "api.eu-west-2.outscale.com"
    },
    {
      "RegionName": "us-east-2",
      "Endpoint": "api.us-east-2.outscale.com"
    },
    {
      "RegionName": "us-west-1",
      "Endpoint": "api.us-west-1.outscale.com"
    }
  ]
}

Getting Information About Regions 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 Regions, use the describe-regions command following this syntax:

Request sample
$ aws ec2 describe-regions \
    --region-names NOT_SPECIFIED \
    --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) 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. For more information, see Installing and Configuring AWS CLI.

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"
        }
    ]
}

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