Skip to main content

Find zones by filtering criteria

GET 
/v1/projects/:projectId/zones

Return zones that match all searching criteria. Criteria are project identifier, region, country code and city.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

Query Parameters

    region string

    Region

    • AMER: South and North America
    • APAC: Asia, Pacific
    • EUR: Europe
    • IMEAR: rest of the world
    countryCode string

    Possible values: >= 2 characters and <= 2 characters

    Country code (on 2 characters)

    city string

    City of the POP

    offset int32

    Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.

    Default value: 0
    limit int32

    Possible values: >= 1

    Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).

    Default value: 100
    sort string

    Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

    The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

Header Parameters

    X-API-KEY string

    Your SIU token if you use this API through Orange Developer.

    Authorization string

    Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

    X-Requester-Id string

    Your SIU Id if you use this API through Orange Developer Inside.

Responses​

Ok

Response Headers
    X-Total-Count

    Returns Pagination of response. The total number of items in the collection, after application of filters if any.

    X-Result-Count

    The actual number of items contained in the response body. Note that it can be less than the requested "limit".

Schema
  • Array [
    • namestringrequired

    Unique resource name.

    descriptionstring

    Resource description.

    regionstringrequired

    Region

    • AMER: South and North America
    • APAC: Asia, Pacific
    • EUR: Europe
    • IMEAR: rest of the world
    countryCodestringrequired

    Country code (on 2 characters)

    Possible values: >= 2 characters and <= 2 characters, Value must match regular expression [A-Z]{2}

    citystringrequired

    City name

    scopeZoneScopeEnum (string)required

    Scope of the POP

    Possible values: [international, france]

    categoryZoneCategoryEnum (string)required

    Category of the POP

    Possible values: [sdn-pop, sdn-pop-v2]

    stateZoneStateEnum (string)required

    Status of the POP: "active", "active, to be closed" (no new VM can be instantiated), "maintenance" (VM deployment temporarily blocked)

    Possible values: [active, active, to be closed, maintenance]

    computeClassesstring[]required

    Compute classes available on the POP.

    carbonFootprint objectrequired

    Carbon footprint info.

    lastUpdateDatestringrequired

    Date of the latest update of the Carbon Footprint data.

    totalFootprintfloatrequired

    Total Carbon Footprint (tCO2e/year)

    allocatedVcpuint32required

    Estimation of the total number of vCpu allocated.

  • ]
curl -L '/v1/projects/:projectId/zones' \
-H 'Accept: application/json'
Request Collapse all
Base URL
/v1
Parameters
— pathrequired
— query
— query
— query
— query
— query
— query
— header
— header
— header