DescribeTenant-阿里云帮助中心

View 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	OceanBase cluster ID.	ob317v4uif****
TenantId	string	Yes	Tenant ID.	t4pnum****

Response elements

Element	Type	Description	Example
	object	Detailed tenant information.
RequestId	string	Request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C
Tenant	object	Tenant information.
TenantId	string	Tenant ID.	t4louaeei****
TenantName	string	Tenant name.	forMySQLTenant
TenantMode	string	Tenant mode. Supported values: Oracle: Oracle mode. MySQL: MySQL mode.	MySQL
VpcId	string	VPC ID. If you do not have a suitable VPC, create one as instructed on the console. For more information, see What is a virtual private cloud?	vpc-bp1d2q3mhg9i23ofi****
Status	string	Tenant status: ONLINE: running. PENDING_CREATE: creating. WAITING_ALLOCATE_MASTER_ADDRESS: (secondary database) waiting to create primary endpoint. ALLOCATING_MASTER_ADDRESS: creating primary endpoint. DELETING_MASTER_ADDRESS: deleting primary endpoint. ALLOCATING_INTERNET_ADDRESS: creating public endpoint. PENDING_OFFLINE_INTERNET_ADDRESS: deleting public endpoint. ALLOCATING_READONLY_ADDRESS: creating read-only endpoint. DELETING_READONLY_ADDRESS: deleting read-only endpoint. ALLOCATING_READWRITE_ADDRESS: creating read/write splitting endpoint. DELETING_READWRITE_ADDRESS: deleting read/write splitting endpoint. ALLOCATING_CLOGSERVICE_ADDRESS: creating transaction log endpoint. DELETING_CLOGSERVICE_ADDRESS: deleting transaction log endpoint. MODIFYING_ADDRESS: modifying endpoint domain name. MODIFYING_PRIMARY_ZONE: switching primary zone. MODIFYING_READONLY_ADDRESS: modifying read-only endpoint. MODIFYING_READWRITE_ADDRESS: modifying read/write splitting endpoint. SPEC_MODIFYING: modifying specifications. WHITE_LIST_MODIFYING: modifying whitelist. CREATING_BINLOG: creating Binlog.	ONLINE
EnableInternetAddressService	boolean	Indicates whether the tenant's public endpoint can be enabled.	true
PrimaryZone	string	Primary zone of the tenant.	cn-hangzhou-h
DeployType	string	Cluster deployment type. multiple: multi-data center. single: single data center. dual: dual data center.	multiple
DeployMode	string	Data replica mode of the tenant. For High-availability Edition: N-N-N for three regions; N-N for two zones and single zone. For Basic Edition: N. Note N is 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	Tenant description.	paycore database
CreateTime	string	Tenant creation time.	2023-04-21 11:15:47.0
TenantResource	object	Tenant resource information.
UnitNum	integer	Number of tenant units.	1
Cpu	object	CPU resource information of the tenant.
UsedCpu	number	Used CPU cores of the tenant. Unit: Core.	8
TotalCpu	number	Total CPU cores of the tenant. Unit: Core.	10
UnitCpu	number	CPU cores per unit of the tenant. Unit: Core.	8
Memory	object	Memory resource information of the tenant.
UsedMemory	number	Used memory of the tenant. Unit: GB.	30
TotalMemory	number	Total memory size of the tenant. Unit: GB.	64
UnitMemory	number	Memory size per unit of the tenant. Unit: GB.	32
DiskSize	object	Disk resource information of the tenant.
UsedDiskSize	number	Used disk size of the tenant. Unit: GB.	86
CapacityUnit	object	Capacity unit.
MaxCapacityUnit	integer	Maximum capacity unit.	16
MinCapacityUnit	integer	Minimum capacity unit.	1
UsedCapacit	integer	Used capacity unit.	5
LogDiskSize	object	Log disk resource information of the tenant.
TotalLogDisk	integer	Total allocated log disk size of the tenant. Unit: GB.	8.0
UnitLogDisk	integer	Allocated log disk size per unit of the tenant. Unit: GB.	8.0
TenantConnections	array<object>	Connection information of the tenant.
	object	Connection information of the tenant.
IntranetAddress	string	Private endpoint for accessing the tenant.	t4nunwxr0****.oceanbase.aliyuncs.com
IntranetPort	integer	Private port for accessing the tenant.	2983
InternetAddress	string	Public endpoint for accessing the tenant.	t4nunwxr0****-mi.oceanbase.aliyuncs.com
InternetPort	integer	Public port for accessing the tenant.	3306
VpcId	string	VPC ID.	vpc-bp1qiail1asmfe23t****
VSwitchId	string	VSwitch ID.	vsw-bp1i7b94u2et716yl****
IntranetAddressMasterZoneId	string	Primary zone corresponding to the tenant's connection endpoint.	cn-hangzhou-b
IntranetAddressSlaveZoneId	string	Secondary zone corresponding to the tenant's connection endpoint.	cn-hangzhou-g
IntranetAddressStatus	string	Status of the tenant's private endpoint. ONLINE: in service.	ONLINE
ConnectionZones	array	List of zones accessible through the tenant connection.	["cn-hangzhou-i", "cn-hangzhou-j"]
	string	Zone accessible through the tenant connection.	cn-hangzhou-b
InternetAddressStatus	string	Status of the tenant's public network connection. CLOSED: shutdown. ALLOCATING_INTERNET_ADDRESS: requesting. PENDING_OFFLINE_INTERNET_ADDRESS: shutting down public endpoint. ONLINE: in service.	CLOSED
TransactionSplit	boolean	Indicates whether transaction splitting is enabled.	false
AddressType	string	Endpoint type. MASTER: primary endpoint, supports read and write. READONLY: read-only endpoint, supports read only. READWRITE: read/write splitting endpoint, enables automatic read/write splitting. CLOGSERVICE: transaction log service endpoint. Valid values: MASTER : MASTER READWRITE : READWRITE CLOGSERVICE : CLOGSERVICE READONLY : READONLY	READONLY
EnableTransactionSplit	boolean	Indicates whether transaction splitting is enabled.	false
ParallelQueryDegree	integer	Degree of parallelism.	1
TenantEndpointId	string	Tenant endpoint ID.	obe-4tw51gp7****
MaxConnectionNum	integer	Maximum connections.	5000
ConnectionReplicaType	string	Replica type corresponding to the connection.	FULL
ProxyClusterId	string	ODP cluster ID.	proxy-xxxxxxx
MaxConnectionLimit	integer	Current value of maximum private connections.	1000
InternetMaxConnectionLimit	integer	Upper limit of maximum public connections.	4000
IntranetRpcPort	integer	Private bypass import port.	3307
InternetMaxConnectionNum	integer	Current value of maximum public connections.	2500
InternetRpcPort	integer	Public bypass import port.	3307
ConnectionLogicalZones	array	Logical zones where the endpoint resides.
	string	Information about the logical zone where the endpoint resides.	cn-bejing-3-z0,cn-bejing-4-z0
IntranetSqlPort	integer	Private SQL port.	3306
OdpVersion	string	ODP version.	4.3.1-xxxxxxxxx
InternetSqlPort	integer	Public SQL port.
InternetAddressServiceType	string	Type of public endpoint.
IntranetAddressServiceType	string	Type of private endpoint.
TenantZones	array<object>	Zone information of the tenant.
	array<object>	Zone information of the tenant.
TenantZoneId	string	Tenant zone ID.	cn-hangzhou-h
Region	string	Region to which the tenant zone belongs.	cn-hangzhou
TenantZoneRole	string	Role of the tenant zone.	ReadWrite
TenantZoneReplicas	array<object>	Replica information of the tenant zone.
	object	Replica information of the tenant zone.
ZoneReplicaType	string	Replica type of the zone.	FULL
ZoneNodes	integer	Zone nodes.	1
LogicZoneName	string	Logical zone name.	cn-shanghai-f-z0
ZoneCopyId	integer	Zone replica ID.	2
FullCopyId	integer	Full-function replica ID.	3
ReadOnlyCopyId	string	Read-only replica ID.	3
ReadOnlyReplicaType	string	Read-only replica type.	ROW_STORE
ClogServiceStatus	string	Clog service status. CLOSED: shutdown. ONLINE: in service.	ONLINE
EnableClogService	boolean	Indicates whether Clog service is available. To enable it, submit a ticket.	true
Charset	string	Character set.	gb18030
Collation	string	Collation.	gb18030_chinese_ci
PrimaryZoneDeployType	string	Deployment mode of the tenant's primary zone. Valid values: RANDOM : RANDOM STATIC : STATIC	STATIC
MasterIntranetAddressZone	string	Zone where the Master node resides.	cn-hangzhou-h
PayType	string	Payment type.	POSTPAY
InstanceType	string	Instance type.	KAFKA_PUBLIC
Series	string	Instance edition.	normal
DiskType	string	Disk type.	cloud_essd_pl1
AvailableZones	array	List of available zones.
	string	List of available zones.	["cn-hangzhou-i"]
EnableReadWriteSplit	boolean	Indicates whether read/write splitting endpoint can be enabled.	true
EnableParallelQuery	boolean	Indicates whether parallel query can be enabled.	true
MaxParallelQueryDegree	integer	Upper limit of degree of parallelism.	32
EnableBinlogService	boolean	Indicates whether Binlog service can be requested.	true
TimeZone	string	Time zone.	Asia/Shanghai
DataMergeTime	string	Tenant merge time. Supported only in OceanBase V4.0.0 and later.	02:36Z
ReadOnlyResource	object	Read-only resource information.
UnitNum	integer	Number of tenant units.	2
Cpu	object	CPU per replica node in the cluster. Unit: Core.
UsedCpu	number	Used CPU of the cluster. Unit: Core.	8
TotalCpu	number	Total CPU cores of the tenant. Unit: Core.	10
UnitCpu	number	CPU cores per unit of the tenant. Unit: Core.	8
Memory	object	Cluster memory information.
UsedMemory	number	Used memory of the tenant. Unit: GB.	30
TotalMemory	number	Total memory size of the tenant. Unit: GB.	64
UnitMemory	number	Memory size per unit of the tenant. Unit: GB.	32
DiskSize	object	Data disk size specification.
UsedDiskSize	number	Used disk size of the tenant. Unit: GB.	86
CapacityUnit	object	Capacity unit information.
MaxCapacityUnit	integer	Maximum capacity unit.	16
MinCapacityUnit	integer	Minimum capacity unit.	1
UsedCapacit	integer	Used capacity unit.	5
LogDiskSize	object	Log disk size information.
TotalLogDisk	integer	Total log disk size. Unit: GB.	8.0
UnitLogDisk	integer	Log disk unit.	8.0
EnableReadOnlyReplica	boolean	Indicates whether read-only replicas are supported.	true
RecycleBinStatus	string	Tenant recycle bin status. ON indicates enabled. OFF indicates disabled.	ON
LowerCaseTableNames	integer	Indicates whether table names are case-sensitive. Valid values: 1: not case-sensitive 0: case-sensitive	1
Version	string	Version information.	4.2.1
OdpVersion	string	ODP version.	4.3.1-xxxxxxxxx
TenantMaxConnections	integer	Maximum allowed connections for the tenant.	1600
ParameterTemplate	string	Parameter template.	express_oltp
Iops	integer	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.