Get Region for entities

Api to fetch region for multiple entity

Query Parameters

• entityType string required

  Possible values: [COMMCELL, CLIENT, INSTANCE, BACKUPSET, SUBCLIENT, CLIENT_GROUP, USER, USER_GROUP, LIBRARY, MEDIAAGENT, RESOURCEPOOL, STORAGE_POOL, STORAGE_POLICY, SCHEDULE_POLICY, SUBCLIENT_POLICY, ALERT, PLAN, VIRTUAL_MACHINE, ROLE, DEVICE, REGION, NETWORK_TOPOLOGY, COMPANY]

  Entity Type Enum

  Example: CLIENT
• regionType string

  Possible values: [BACKUP, WORKLOAD]

  Region Type Enum

  Example: BACKUP
• entities string required

  Comma Seprated Entity Ids

  Example: 1,2,3

Responses

• 200
• 400

---

Success

application/json

• Schema
• Example (from schema)
• Region For Entities

---

Schema

• regions object[]

  id int32

  name string

  entityId int32
• entityType string

  Possible values: [COMMCELL, CLIENT, INSTANCE, BACKUPSET, SUBCLIENT, CLIENT_GROUP, USER, USER_GROUP, LIBRARY, MEDIAAGENT, RESOURCEPOOL, STORAGE_POOL, STORAGE_POLICY, SCHEDULE_POLICY, SUBCLIENT_POLICY, ALERT, PLAN, VIRTUAL_MACHINE, ROLE, DEVICE, REGION, NETWORK_TOPOLOGY, COMPANY]

• regionType string

  Possible values: [BACKUP, WORKLOAD]

• error object

  errorMessage string

  errorCode int32

{
  "regions": [
    {
      "id": 0,
      "name": "string",
      "entityId": 0
    }
  ],
  "entityType": "COMMCELL",
  "regionType": "BACKUP",
  "error": {
    "errorMessage": "string",
    "errorCode": 0
  }
}

{
  "regions": [
    {
      "id": 43,
      "name": "South India",
      "entityId": 1
    },
    {
      "id": 5,
      "name": "North America",
      "entityId": 2
    },
    {
      "id": 4,
      "name": "Europe",
      "entityId": 3
    }
  ],
  "entityType": "CLIENT",
  "regionType": "BACKUP",
  "error": {
    "errorCode": 0,
    "errorMessage": ""
  }
}

Bad Request

Loading...