All Products
Search
Document Center

Data Management:GetUserActiveTenant

Last Updated:Jul 01, 2024

Queries details of the active tenant.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

3***

Response parameters

ParameterTypeDescriptionExample
object
Tenantobject

The details of the tenant.

Statusstring

The status of the tenant. Valid values:

  • ACTIVE: The tenant is used to access DMS.
  • IN_ACTIVE: The tenant is not used.
ACTIVE
Tidlong

The ID of the tenant.

3***
TenantNamestring

The name of the tenant.

test_name
RequestIdstring

The ID of the request.

4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2
ErrorCodestring

The error code.

TenantNotExist
ErrorMessagestring

The error message.

The specified tenant does not exist.
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true

Examples

Sample success responses

JSONformat

{
  "Tenant": {
    "Status": "ACTIVE",
    "Tid": 0,
    "TenantName": "test_name"
  },
  "RequestId": "4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2",
  "ErrorCode": "TenantNotExist",
  "ErrorMessage": "The specified tenant does not exist.",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history