Skip to content

Register a Tenant

API Overview

Use this API to create a tenant. A tenant is a logical isolation unit in the system; data is not shared across tenants.

API URL

POST  Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/tenant/registerTenant

To obtain anymetrics_host:anymetrics_port, see Calling APIs.

Request parameters

Common Request Headers

parameter Type required Max Length Description Example Value
user-id String Yes 1024 user ID 338979817842016256

Request parameters

parameter Type required Max Length Description Example Value
displayName String Yes 64 Tenant display name TenantT00021

Response parameters

parameter Type required Max Length Description Example Value
code String Yes 32 API response code 200
success boolean Yes Whether successful true
errorMsg String Yes 512 Request error message NUll
detailErrorMsg String Yes 512 Detailed error message NULl
traceId String Yes 128 traceId fdde6861bd554805998343f9ff2dcd70.292.16857691758642861
data String Yes 16 Registered tenant ID tn_20110446

Request Example

{
    "displayName": "Tenant123",
}

Response Example

{
    "data": "tn_20110446",
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "2bc7df9f294144deab6535e0b2a9b546.151.17234454817490911"
}