GetUserActiveTenant - Data Management

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.	3***

Response parameters

Parameter	Type	Description	Example
	object
Tenant	object	The details of the tenant.
Status	string	The status of the tenant. Valid values: ACTIVE: The tenant is used to access DMS. IN_ACTIVE: The tenant is not used.	ACTIVE
Tid	long	The ID of the tenant.	3***
TenantName	string	The name of the tenant.	test_name
RequestId	string	The ID of the request.	4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2
ErrorCode	string	The error code.	TenantNotExist
ErrorMessage	string	The error message.	The specified tenant does not exist.
Success	boolean	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 time	Summary of changes	Operation

No change history