Query tenant information by using DescribeTenant - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud - ApsaraDB for OceanBase (Deprecated)

Queries the information about a specified tenant in a specified cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeTenant

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
TenantId	string	Yes	The ID of the tenant.	t4pnum****

Response elements

Element	Type	Description	Example
	object	The detailed information about the tenant.
RequestId	string	The request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C
Tenant	object	The tenant information.
TenantId	string	The ID of the tenant.	t4louaeei****
TenantName	string	The tenant name.	forMySQLTenant
TenantMode	string	The tenant mode. Valid values: Oracle: Oracle mode. MySQL: MySQL mode.	MySQL
VpcId	string	The virtual private cloud (VPC) ID. If no suitable VPC is available, create one by following the on-screen instructions. For more information, see What is a VPC?.	vpc-bp1d2q3mhg9i23ofi****
Status	string	The tenant status. Valid values: ONLINE: Running. PENDING_CREATE: Being created. WAITING_ALLOCATE_MASTER_ADDRESS: (Standby) Waiting for the primary address to be created. ALLOCATING_MASTER_ADDRESS: Primary address being created. DELETING_MASTER_ADDRESS: Primary address being deleted. ALLOCATING_INTERNET_ADDRESS: Public network address being created. PENDING_OFFLINE_INTERNET_ADDRESS: Public network address being deleted. ALLOCATING_READONLY_ADDRESS: Read-only address being created. DELETING_READONLY_ADDRESS: Read-only address being deleted. ALLOCATING_READWRITE_ADDRESS: Read/write splitting address being created. DELETING_READWRITE_ADDRESS: Read/write splitting address being deleted. ALLOCATING_CLOGSERVICE_ADDRESS: Transaction log address being created. DELETING_CLOGSERVICE_ADDRESS: Transaction log address being deleted. MODIFYING_ADDRESS: Address domain name being modified. MODIFYING_PRIMARY_ZONE: Primary zone being switched. MODIFYING_READONLY_ADDRESS: Read-only address being modified. MODIFYING_READWRITE_ADDRESS: Read/write splitting address being modified. SPEC_MODIFYING: Specifications being modified. WHITE_LIST_MODIFYING: Whitelist being modified. CREATING_BINLOG: Binary log being created.	ONLINE
EnableInternetAddressService	boolean	Indicates whether the public network address service can be enabled for the tenant.	true
PrimaryZone	string	The primary zone of the tenant.	cn-hangzhou-h
DeployType	string	The deployment type of the cluster. Valid values: multiple: multi-IDC deployment. single: single-IDC deployment. dual: dual-IDC deployment.	multiple
DeployMode	string	The data replica mode of the tenant. For the high-availability edition: N-N-N for three zones, and N-N for two zones or a single zone. For the basic edition: N. N represents the number of nodes in a single zone.	FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j
Description	string	The description of the tenant.	paycore database
CreateTime	string	The creation time of the tenant.	2023-04-21 11:15:47.0
TenantResource	object	The resource information of the tenant.
UnitNum	integer	The number of units in the tenant.	1
Cpu	object	The CPU resource information of the tenant.
UsedCpu	number	The number of CPU cores used by the tenant. Unit: Core.	8
TotalCpu	number	The total number of CPU cores of the tenant. Unit: Core.	10
UnitCpu	number	The number of CPU cores per unit of the tenant. Unit: Core.	8
Memory	object	The memory resources information of the tenant.
UsedMemory	number	The memory used by the tenant. Unit: GB.	30
TotalMemory	number	The total memory size of the tenant. Unit: GB.	64
UnitMemory	number	The memory size per unit of the tenant. Unit: GB.	32
DiskSize	object	The disk resource information of the tenant.
UsedDiskSize	number	The disk size used by the tenant. Unit: GB.	86
CapacityUnit	object	The capacity unit.
MaxCapacityUnit	integer	The maximum capacity unit.	16
MinCapacityUnit	integer	The minimum capacity unit.	1
UsedCapacit	integer	The used capacity unit.	5
LogDiskSize	object	The log disk resource information of the tenant.
TotalLogDisk	integer	The total log disk size allocated to the tenant. Unit: GB.	8.0
UnitLogDisk	integer	The log disk size allocated per unit of the tenant. Unit: GB.	8.0
TenantConnections	array<object>	The connection information of the tenant.
	object	The connection information of the tenant.
IntranetAddress	string	The private network endpoint for accessing the tenant.	t4nunwxr0****.oceanbase.aliyuncs.com
IntranetPort	integer	The private network connection port for accessing the tenant.	2983
InternetAddress	string	The public network connection address for accessing the tenant.	t4nunwxr0****-mi.oceanbase.aliyuncs.com
InternetPort	integer	The public network connection port for accessing the tenant.	3306
VpcId	string	The virtual private cloud (VPC) ID.	vpc-bp1qiail1asmfe23t****
VSwitchId	string	The vSwitch ID.	vsw-bp1i7b94u2et716yl****
IntranetAddressMasterZoneId	string	The active zone corresponding to the endpoint for accessing the tenant.	cn-hangzhou-b
IntranetAddressSlaveZoneId	string	The secondary zone corresponding to the endpoint for accessing the tenant.	cn-hangzhou-g
IntranetAddressStatus	string	The status of the private network endpoint for accessing the tenant.	ONLINE
ConnectionZones	array	The list of zones corresponding to the tenant connection.	["cn-hangzhou-i", "cn-hangzhou-j"]
	string	The zone corresponding to the tenant connection.	cn-hangzhou-b
InternetAddressStatus	string	The status of the public network connection for accessing the tenant. Valid values: CLOSED: Closed. ALLOCATING_INTERNET_ADDRESS: Being allocated. PENDING_OFFLINE_INTERNET_ADDRESS: The public network address is being closed. ONLINE: In service.	CLOSED
TransactionSplit	boolean	Indicates whether transaction splitting is enabled.	false
AddressType	string	The address type. Valid values: MASTER: Primary address. Supports read and write operations. READONLY: Read-only address. Supports only read operations. READWRITE: Read/write splitting address. Automatically splits read and write operations. CLOGSERVICE: Transaction log service address. Valid values: MASTER : MASTER READWRITE : READWRITE CLOGSERVICE : CLOGSERVICE READONLY : READONLY	READONLY
EnableTransactionSplit	boolean	Indicates whether transaction splitting is enabled.	false
ParallelQueryDegree	integer	The degree of parallelism.	1
TenantEndpointId	string	The tenant endpoint ID.	obe-4tw51gp7****
MaxConnectionNum	integer	The maximum number of connections.	5000
ConnectionReplicaType	string	The replica type corresponding to the connection.	FULL
ProxyClusterId	string	The ODP cluster ID.	proxy-xxxxxxx
MaxConnectionLimit	integer	The current value of the maximum number of private network connections.	1000
InternetMaxConnectionLimit	integer	The upper limit of the maximum number of public network connections.	4000
IntranetRpcPort	integer	The private network bypass import port.	3307
InternetMaxConnectionNum	integer	The current value of the maximum number of public network connections.	2500
InternetRpcPort	integer	The public network bypass import port.	3307
ConnectionLogicalZones	array	The logical zones where the address is located.
	string	The logical zone information where the address is located.	cn-bejing-3-z0,cn-bejing-4-z0
IntranetSqlPort	integer	The private network SQL port.	3306
OdpVersion	string	The ODP version.	4.3.1-xxxxxxxxx
InternetSqlPort	integer	The public network SQL port.
InternetAddressServiceType	string	The service type of the public network address.
IntranetAddressServiceType	string	The service type of the private network address.
TenantZones	array<object>	The zone information of the tenant.
	array<object>	The zone information of the tenant.
TenantZoneId	string	The tenant zone ID.	cn-hangzhou-h
Region	string	The region to which the tenant zone belongs.	cn-hangzhou
TenantZoneRole	string	The role of the tenant zone.	ReadWrite
TenantZoneReplicas	array<object>	The replica information of the tenant zone.
	object	The replica information of the tenant zone.
ZoneReplicaType	string	The zone replica type.	FULL
ZoneNodes	integer	The zone nodes.	1
LogicZoneName	string	The logical zone name.	cn-shanghai-f-z0
ZoneCopyId	integer	The zone replica ID.	2
FullCopyId	integer	The full-featured replica ID.	3
ReadOnlyCopyId	string	The read-only replica ID.	3
ReadOnlyReplicaType	string	The read-only replica type.	ROW_STORE
ClogServiceStatus	string	The enabling status of the Clog service. Valid values: CLOSED: Disabled. ONLINE: Active.	ONLINE
EnableClogService	boolean	Indicates whether the Clog service is available. To enable this service, submit a ticket.	true
Charset	string	The character set.	gb18030
Collation	string	The collation.	gb18030_chinese_ci
PrimaryZoneDeployType	string	The deployment type of the tenant primary zone. Valid values: RANDOM : RANDOM STATIC : STATIC	STATIC
MasterIntranetAddressZone	string	The zone where the master node is located.	cn-hangzhou-h
PayType	string	The billing method.	POSTPAY
InstanceType	string	The instance type.	KAFKA_PUBLIC
Series	string	The instance edition.	normal
DiskType	string	The disk type.	cloud_essd_pl1
AvailableZones	array	The list of zones.
	string	The list of zones.	["cn-hangzhou-i"]
EnableReadWriteSplit	boolean	Indicates whether the read/write splitting address is allowed to be enabled.	true
EnableParallelQuery	boolean	Indicates whether parallel query is allowed to be enabled.	true
MaxParallelQueryDegree	integer	The upper limit of the parallelism degree setting.	32
EnableBinlogService	boolean	Indicates whether the Binlog service can be requested.	true
TimeZone	string	The time zone.	Asia/Shanghai
DataMergeTime	string	The tenant merge time. This parameter is supported only for OceanBase V4.0.0 and later.	02:36Z
ReadOnlyResource	object	The read-only resource information.
UnitNum	integer	The number of units in the tenant.	2
Cpu	object	The CPU of each replica node in the cluster. Unit: cores.
UsedCpu	number	The used CPU of the cluster. Unit: cores.	8
TotalCpu	number	The total number of CPU cores of the tenant. Unit: Core.	10
UnitCpu	number	The number of CPU cores per unit of the tenant. Unit: Core.	8
Memory	object	The cluster memory information.
UsedMemory	number	The memory used by the tenant. Unit: GB.	30
TotalMemory	number	The total memory size of the tenant. Unit: GB.	64
UnitMemory	number	The memory size of each unit of the tenant. Unit: GB.	32
DiskSize	object	The data disk size specification.
UsedDiskSize	number	The disk size used by the tenant. Unit: GB.	86
CapacityUnit	object	The capacity unit information.
MaxCapacityUnit	integer	The maximum capacity unit.	16
MinCapacityUnit	integer	The minimum capacity unit.	1
UsedCapacit	integer	The used capacity unit.	5
LogDiskSize	object	The log disk size information.
TotalLogDisk	integer	The total log disk size. Unit: GB.	8.0
UnitLogDisk	integer	The log disk unit.	8.0
EnableReadOnlyReplica	boolean	Indicates whether read-only replicas are supported.	true
RecycleBinStatus	string	The tenant recycle bin status. ON indicates enabled and OFF indicates disabled.	ON
LowerCaseTableNames	integer	Indicates whether table names are case-sensitive. Valid values:	1
Version	string	The version information.	4.2.1
OdpVersion	string	The ODP version.	4.3.1-xxxxxxxxx
TenantMaxConnections	integer	The maximum number of connections allowed for the tenant.	1600
ParameterTemplate	string	The parameter template.	express_oltp
Iops	integer	The tenant IOPS.	10000

Examples

Success response

JSON format

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Tenant": {
    "TenantId": "t4louaeei****",
    "TenantName": "forMySQLTenant",
    "TenantMode": "MySQL",
    "VpcId": "vpc-bp1d2q3mhg9i23ofi****",
    "Status": "ONLINE",
    "EnableInternetAddressService": true,
    "PrimaryZone": "cn-hangzhou-h",
    "DeployType": "multiple",
    "DeployMode": "FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j",
    "Description": "paycore database",
    "CreateTime": "2023-04-21 11:15:47.0",
    "TenantResource": {
      "UnitNum": 1,
      "Cpu": {
        "UsedCpu": 8,
        "TotalCpu": 10,
        "UnitCpu": 8
      },
      "Memory": {
        "UsedMemory": 30,
        "TotalMemory": 64,
        "UnitMemory": 32
      },
      "DiskSize": {
        "UsedDiskSize": 86
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 16,
        "MinCapacityUnit": 1,
        "UsedCapacit": 5
      },
      "LogDiskSize": {
        "TotalLogDisk": 8,
        "UnitLogDisk": 8
      }
    },
    "TenantConnections": [
      {
        "IntranetAddress": "t4nunwxr0****.oceanbase.aliyuncs.com",
        "IntranetPort": 2983,
        "InternetAddress": "t4nunwxr0****-mi.oceanbase.aliyuncs.com",
        "InternetPort": 3306,
        "VpcId": "vpc-bp1qiail1asmfe23t****",
        "VSwitchId": "vsw-bp1i7b94u2et716yl****",
        "IntranetAddressMasterZoneId": "cn-hangzhou-b",
        "IntranetAddressSlaveZoneId": "cn-hangzhou-g",
        "IntranetAddressStatus": "ONLINE",
        "ConnectionZones": [
          "cn-hangzhou-b"
        ],
        "InternetAddressStatus": "CLOSED",
        "TransactionSplit": false,
        "AddressType": "READONLY",
        "EnableTransactionSplit": false,
        "ParallelQueryDegree": 1,
        "TenantEndpointId": "obe-4tw51gp7****",
        "MaxConnectionNum": 5000,
        "ConnectionReplicaType": "FULL",
        "ProxyClusterId": "proxy-xxxxxxx",
        "MaxConnectionLimit": 1000,
        "InternetMaxConnectionLimit": 4000,
        "IntranetRpcPort": 3307,
        "InternetMaxConnectionNum": 2500,
        "InternetRpcPort": 3307,
        "ConnectionLogicalZones": [
          "cn-bejing-3-z0,cn-bejing-4-z0"
        ],
        "IntranetSqlPort": 3306,
        "OdpVersion": "4.3.1-xxxxxxxxx",
        "InternetSqlPort": 0,
        "InternetAddressServiceType": "",
        "IntranetAddressServiceType": ""
      }
    ],
    "TenantZones": [
      {
        "TenantZoneId": "cn-hangzhou-h",
        "Region": "cn-hangzhou",
        "TenantZoneRole": "ReadWrite",
        "TenantZoneReplicas": [
          {
            "ZoneReplicaType": "FULL",
            "ZoneNodes": 1,
            "LogicZoneName": "cn-shanghai-f-z0",
            "ZoneCopyId": 2,
            "FullCopyId": 3,
            "ReadOnlyCopyId": "3",
            "ReadOnlyReplicaType": "ROW_STORE"
          }
        ]
      }
    ],
    "ClogServiceStatus": "ONLINE",
    "EnableClogService": true,
    "Charset": "gb18030",
    "Collation": "gb18030_chinese_ci",
    "PrimaryZoneDeployType": "STATIC",
    "MasterIntranetAddressZone": "cn-hangzhou-h",
    "PayType": "POSTPAY",
    "InstanceType": "KAFKA_PUBLIC",
    "Series": "normal",
    "DiskType": "cloud_essd_pl1",
    "AvailableZones": [
      "[\"cn-hangzhou-i\"]"
    ],
    "EnableReadWriteSplit": true,
    "EnableParallelQuery": true,
    "MaxParallelQueryDegree": 32,
    "EnableBinlogService": true,
    "TimeZone": "Asia/Shanghai",
    "DataMergeTime": "02:36Z",
    "ReadOnlyResource": {
      "UnitNum": 2,
      "Cpu": {
        "UsedCpu": 8,
        "TotalCpu": 10,
        "UnitCpu": 8
      },
      "Memory": {
        "UsedMemory": 30,
        "TotalMemory": 64,
        "UnitMemory": 32
      },
      "DiskSize": {
        "UsedDiskSize": 86
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 16,
        "MinCapacityUnit": 1,
        "UsedCapacit": 5
      },
      "LogDiskSize": {
        "TotalLogDisk": 8,
        "UnitLogDisk": 8
      }
    },
    "EnableReadOnlyReplica": true,
    "RecycleBinStatus": "ON",
    "LowerCaseTableNames": 1,
    "Version": "4.2.1",
    "OdpVersion": "4.3.1-xxxxxxxxx",
    "TenantMaxConnections": 1600,
    "ParameterTemplate": "express_oltp",
    "Iops": 10000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.