All Products
Search
Document Center

Data Management:GetUserActiveTenant

Last Updated:Nov 28, 2024

Queries details of the active tenant.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetUserActiveTenantget
*All Resources
*
    none
none

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