Get a zone by its name

GET 
/v1/projects/:projectId/zones/:zoneName

Return the zone by its name (in the path).

Request

Path Parameters

projectId stringrequired

Project Identifier

zoneName stringrequired

Zone name

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

200

Ok

application/json

Schema

Schema

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.

Example (auto)

{
  "name": "string",
  "description": "string",
  "region": "string",
  "countryCode": "string",
  "city": "string",
  "scope": "international",
  "category": "sdn-pop",
  "state": "active",
  "computeClasses": [
    "string"
  ],
  "carbonFootprint": {
    "lastUpdateDate": "string",
    "totalFootprint": 0,
    "allocatedVcpu": 0
  }
}

400

Bad Request

Request is not valid

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

Not Found

Unknown resource or service

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

405

Method Not Allowed

Operation is not valid according to the state of the resource

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L '/v1/projects/:projectId/zones/:zoneName' \
-H 'Accept: application/json'

Request Collapse all

Base URL

/v1

Parameters

projectId — pathrequired

zoneName — pathrequired

X-API-KEY — header

Authorization — header

X-Requester-Id — header