Get Region Details
Select
Get details of the region
Path Parameters
- regionId string required
- 200
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- id int32
Region ID
- name string
Region name
- displayName string
Display name for the region
- regionType RegionType
Possible values: [
DEFAULT
,AZURE
,AWS
,USER_CREATED
,OCI
,GCP
]Type of region
locations object[]
List of locations in the region
continent stringName of continent for the location
country stringName of country for the location
state stringName of state for the location
city stringName of city for the location
latitude doubleLatitude for the location
longitude doubleLongitude for the location
zone object
id int32name stringassociatedServers object
Details of servers associated to a region
serversCount int32servers object[]
server object
id int32name stringlatitude doublelongitude doubleassociatedRegionBasedPlans object
Details of plans associated to the region
plansCount int32plans object[]
plan object
id int32name stringassociatedServers int32type stringPossible values: [
Server
,Laptop
,FSIBMiVTL
,ExchangeJournal
,ExchangeUser
,Office365
,DataClassification
,Archiver
,CDM
,ObjectStore
,DLO
,Database
,Snap
,FSServer
,VSAServer
,Dynamics365
]globalConfigInfo object
Only applicable on Global CommCells
id stringname stringcommcells object[]
List of Service CommCells where the global configuration is applied
id int32name stringguid stringscope stringThe entity level at which the config is applied.
scopeFilterQuery stringCommCellEntityCache filter query string used for filtering the scope
applyOnAllCommCells booleanDecides whether the global configuration should be applied to all the Service commcells, including the newly created ones
isMarkedForDeletion booleanIndicates whether global configuration deletion has been started.
status string
{
"id": 0,
"name": "string",
"displayName": "string",
"regionType": "DEFAULT",
"locations": [
{
"continent": "string",
"country": "string",
"state": "string",
"city": "string",
"latitude": 0,
"longitude": 0,
"zone": {
"id": 0,
"name": "string"
}
}
],
"associatedServers": {
"serversCount": 0,
"servers": [
{
"server": {
"id": 0,
"name": "string"
},
"latitude": 0,
"longitude": 0
}
]
},
"associatedRegionBasedPlans": {
"plansCount": 0,
"plans": [
{
"plan": {
"id": 0,
"name": "string"
},
"associatedServers": 0,
"type": "Server"
}
]
},
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}
Internal Server Error