MAmacrometa
Administration

List details of the tenant

Fetch information about the tenant.

Note: Requires administrator permissions.

get/_api/tenant/{tenant}

Request

Path parameters

tenantstring string required

The tenant name for whom we want to fetch info.

Response

Successfully fetched tenant.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

Example response

{
  "code": 200,
  "result": {
    "limits": {
      "apiServer": {
        "maxRequestPerMinute": 60
      },
      "cep": {
        "maxPublishedWorkers": 30,
        "maxWorkersMemoryMB": 500,
        "maxMemoryMBPerWorker": 100,
        "maxWorkersCpuSecondsPerMinute": 60,
        "maxWorkersThroughputInMBPerMinute": 10,
        "maxWorkersThroughputOutMBPerMinute": 10,
        "maxLogsLengthKBPerMinutePerWorker": 10,
        "maxCpuSecondsPerMinutePerWorker": 20
      },
      "database": {
        "maxDocumentSize": 524288,
        "maxDocumentsReturnedByQuery": 1000,
        "maxQueryExecutionTimeInMs": 100000,
        "maxQueryMemoryBytes": 527958016,
        "maxGeoFabricsPerTenant": 2,
        "maxCollectionsPerFabric": 10,
        "maxGraphsPerFabric": 2,
        "maxIndexes": 10,
        "maxViewsPerFabric": 2,
        "maxRequestsPerDay": 20000,
        "maxStoragePerRegion": 412467200,
        "maxRestQLUsagePerFabric": 1000,
        "maxRestQLUsagePerDay": 1000,
        "maxDocumentsImportedPerAPICall": 10000
      },
      "streamsGlobal": {
        "maxStreamsCount": 25,
        "maxProducersCount": 14,
        "maxConsumersCount": 14,
        "maxSubscriptionsCount": 14,
        "maxBacklogMessageTTLMin": 240,
        "maxBacklogStorageSizeMB": 100,
        "maxDispatchThrottlingRateInByte": 4096
      },
      "streamsLocal": {
        "maxStreamsCount": 25,
        "maxProducersCount": 14,
        "maxConsumersCount": 14,
        "maxSubscriptionsCount": 14,
        "maxBacklogMessageTTLMin": 240,
        "maxBacklogStorageSizeMB": 100,
        "maxDispatchThrottlingRateInByte": 4096
      },
      "dataMeshIntegration": {
        "maxConnections": 100,
        "maxWorkflows": 1000
      }
    },
    "tenant": "Test",
    "status": "available",
    "realTime": true,
    "name": "demo._system",
    "clusters": [
      "dc-region1",
      "dc-region2"
    ],
    "features": [
      {
        "KV": true
      }
    ],
    "plan": "enterprise",
    "metadata": {
      "key": "value"
    },
    "dnsInfo": {
      "global_url": "global-url.mydomain.io",
      "regional_urls": {
        "region-name-1": "regional-url-1.mydomain.io",
        "region-name-2": "regional-url-2.mydomain.io"
      },
      "status": {
        "region-name-1": "enabled",
        "region-name-2": "enabled"
      },
      "err_msg": "Error message string"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.