All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeTenant

Last Updated:Apr 29, 2024

You can call this operation to query the information of a specific tenant in a specific cluster.

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
InstanceIdstringYes

The status of the Internet address for accessing the tenant. Valid values:

  • CLOSED: The address is disabled.
  • ALLOCATING_INTERNET_ADDRESS: An address is being applied for.
  • PENDING_OFFLINE_INTERNET_ADDRESS: The address is being disabled.
  • ONLINE: The address is in service.
ob317v4uif****
TenantIdstringYes

Indicates whether to enable transaction splitting.

ob2mr3oae0****

Response parameters

ParameterTypeDescriptionExample
object

The connection access information of the tenant.

RequestIdstring

The zone information of the tenant.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Tenantobject

The ID of the zone.

TenantIdstring

The region where the zone of the tenant resides.

t33h8y08k****
TenantNamestring

The request type of the zone of the tenant. ReadWrite: The zone supports data reads and writes. ReadOnly: The zone supports only data reads. For a high availability cluster with multiple IDCs, the primary zone provides ReadWrite services, and the standby zone provides ReadOnly services. For a high availability cluster with a single IDC, all zones provide ReadWrite services.

pay_online
TenantModestring

The enabling status of the clog service.

  • CLOSED: The clog service is disabled.
  • ONLINE: The clog service is running.
Oracle
VpcIdstring

Indicates whether the clog service is available. To enable the clog service, submit a ticket.

vpc-bp1d2q3mhg9i23ofi****
Statusstring

The character set.

ONLINE
EnableInternetAddressServiceboolean

The deployment type of the primary zone.

true
PrimaryZonestring

The type of the payment.

cn-hangzhou-i
DeployTypestring

The series of the instance.

multiple
DeployModestring

The list of zones.

1-1-1
Descriptionstring

Indicates whether to enable read/write splitting endpoint.

The information of the tenant.
CreateTimestring

You can call this operation to create a single tenant in a specific cluster.

2021-09-17 15:52:17
TenantResourceobject

It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples.

UnitNuminteger

Alibaba Cloud CLI

1
Cpuobject

The enabling status of the Clog service.
CLOSED: The Clog service is disabled.

  • ONLINE: The Clog service is running.
UsedCpufloat

The tenant mode.
Valid values: Oracle
MySQL

8
TotalCpufloat

The data replica distribution mode of the tenant.

  • For the high availability version, N-N-N indicates the three-zone mode, and N-N indicates the dual-zone or single-zone mode.
  • For the basic version, N indicates the single-zone mode.
Note
N represents the number of nodes in a single zone.
10
UnitCpufloat

The zone corresponding to the tenant connection.

8
Memoryobject

The description of the tenant.

UsedMemoryfloat

The status of the Internet address for accessing the tenant. Valid values:
Closed: The address is disabled.

  • ALLOCATING_INTERNET_ADDRESS: An address is being applied for.
  • PENDING_OFFLINE_INTERNET_ADDRESS: The address is being disabled.
  • ONLINE: The address is in service.
30
TotalMemoryfloat

The information about the memory resources of the tenant.

64
UnitMemoryfloat

The time when the tenant was created.

32
DiskSizeobject

The status of the intranet address for accessing the tenant.
The value ONLINE indicates that the address is in service.

UsedDiskSizefloat

The total memory size of the tenant, in GB.

86
TenantConnectionsobject []

The status of the tenant.

  • PENDING_CREATE: The tenant is being created.
  • RESTORE: The tenant is being recovered.
  • ONLINE: The tenant is running.
  • SPEC_MODIFYING: The specification of the tenant is being modified.
  • ALLOCATING_INTERNET_ADDRESS: An Internet address is being allocated.
  • PENDING_OFFLINE_INTERNET_ADDRESS: The Internet address is being disabled.
  • PRIMARY_ZONE_MODIFYING: The tenant is switching to a new primary zone.
  • PARAMETER_MODIFYING: Parameters are being modified.
  • WHITE_LIST_MODIFYING: The whitelist is being modified.
IntranetAddressstring

The deployment type of the cluster. Valid values:

  • multiple: multi-IDC deployment
  • single: single-IDC deployment
  • dual: dual-IDC deployment
t32a7ru5u****.oceanbase.aliyuncs.com
IntranetPortinteger

The ID of the tenant.

3306
InternetAddressstring

The ID of the VPC.

t32a7ru5u****mo.oceanbase.aliyuncs.com
VpcIdstring

The service mode of the connection address. Valid values:
ReadWrite: provides strong-consistency read and write services.
ReadOnly: provides the read-only service to ensure ultimate consistency of data.
Clog: provides transaction log services.

vpc-bp1qiail1asmfe23t****
VSwitchIdstring

The connection access information of the tenant.

vsw-bp11k1aypnzu1l3whi****
IntranetAddressMasterZoneIdstring

PayCore business database

cn-hangzhou-i
IntranetAddressSlaveZoneIdstring

The total number of CPU cores of the tenant.

cn-hangzhou-j
ConnectionZonesarray

The Internet address for accessing the tenant.

string

The Internet port for accessing the tenant.

cn-hangzhou-i
TransactionSplitboolean

The primary zone corresponding to the address for accessing the tenant.

true
AddressTypestring

The primary zone of the tenant.

MASTER
TenantZonesobject []

The standby zone corresponding to the address for accessing the tenant.

TenantZoneIdstring

The intranet port for accessing the tenant.

cn-hangzhou-i
TenantZoneRolestring

The character set.

ReadOnly
EnableClogServiceboolean

The intranet address for accessing the tenant.

false
Charsetstring

The number of CPU cores in each resource unit of the tenant.

utf8mb4
Collationstring

The request ID.

utf8mb4_general_ci
PrimaryZoneDeployTypestring

Example 1

Enumeration Value:
  • RANDOM: RANDOM.
  • STATIC: STATIC.
RANDOM
MasterIntranetAddressZonestring
http(s)://[Endpoint]/?Action=DescribeTenant
&InstanceId=ob317v4uif****
&TenantId=ob2mr3oae0****
&Common request parameters
cn-hangzhou-h
PayTypestring
POSTPAY
InstanceTypestring

{ "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C", "Tenant": { "TenantId": "t33h8y08k****", "TenantName": "pay_online", "TenantMode": "Oracle", "VpcId": "vpc-bp1d2q3mhg9i23ofi****", "Status": "ONLINE", "PrimaryZone": "cn-hangzhou-i", "DeployType": "multiple", "DeployMode": "1-1-1", "Description": "PayCore business database", "CreateTime": "2021-09-17 15:52:17", "TenantResource": { "UnitNum": 1, "Cpu": { "UsedCpu": 8, "TotalCpu": 10, "UnitCpu": 8 }, "Memory": { "UsedMemory": 30, "TotalMemory": 64, "UnitMemory": 32 }, "DiskSize": { "UsedDiskSize": 86 } }, "TenantConnections": [ { "ConnectionRole": "ReadWrite", "IntranetAddress": "t32a7ru5u****.oceanbase.aliyuncs.com", "IntranetPort": 3306, "InternetAddress": "t32a7ru5umo.oceanbase.aliyuncs.com", "InternetPort": 3306, "VpcId": "vpc-bp1qiail1asmfe23t", "VSwitchId": "vsw-bp11k1aypnzu1l3whi****", "IntranetAddressMasterZoneId": "cn-hangzhou-i", "IntranetAddressSlaveZoneId": "cn-hangzhou-j", "IntranetAddressStatus": "ONLINE", "ConnectionZones": [ "cn-hangzhou-i" ], "InternetAddressStatus": "CLOSED" } ], "TenantZones": [ { "TenantZoneId": "cn-hangzhou-i", "Region": "cn-hangzhou", "TenantZoneRole": "ReadOnly" } ], "ClogServiceStatus": "CLOSED" } }

KAFKA_PUBLIC
Seriesstring
EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C t33h8y08k**** pay_online Oracle vpc-bp1d2q3mhg9i23ofi**** ONLINE cn-hangzhou-i multiple 1-1-1 PayCore business database 2021-09-17 15:52:17 1 8 10 8 30 64 32 86 ReadWrite t32a7ru5u****.oceanbase.aliyuncs.com 3306 t32a7ru5u****mo.oceanbase.aliyuncs.com 3306 vpc-bp1qiail1asmfe23t**** vsw-bp11k1aypnzu1l3whi**** cn-hangzhou-i cn-hangzhou-j ONLINE cn-hangzhou-i CLOSED cn-hangzhou-i cn-hangzhou ReadOnly CLOSED
normal
DiskTypestring

You can call this operation to query the information of a specific tenant in a specific cluster.

cloud_essd_pl1
AvailableZonesarray

DescribeTenant

string
["cn-hangzhou-i"]

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Tenant": {
    "TenantId": "t33h8y08k****",
    "TenantName": "pay_online",
    "TenantMode": "Oracle",
    "VpcId": "vpc-bp1d2q3mhg9i23ofi****",
    "Status": "ONLINE",
    "EnableInternetAddressService": true,
    "PrimaryZone": "cn-hangzhou-i",
    "DeployType": "multiple",
    "DeployMode": "1-1-1",
    "Description": "The information of the tenant. ",
    "CreateTime": "2021-09-17 15:52:17",
    "TenantResource": {
      "UnitNum": 1,
      "Cpu": {
        "UsedCpu": 8,
        "TotalCpu": 10,
        "UnitCpu": 8
      },
      "Memory": {
        "UsedMemory": 30,
        "TotalMemory": 64,
        "UnitMemory": 32
      },
      "DiskSize": {
        "UsedDiskSize": 86
      }
    },
    "TenantConnections": [
      {
        "ConnectionRole": "ReadWrite",
        "IntranetAddress": "t32a7ru5u****.oceanbase.aliyuncs.com",
        "IntranetPort": 3306,
        "InternetAddress": "t32a7ru5u****mo.oceanbase.aliyuncs.com",
        "InternetPort": 3306,
        "VpcId": "vpc-bp1qiail1asmfe23t****",
        "VSwitchId": "vsw-bp11k1aypnzu1l3whi****",
        "IntranetAddressMasterZoneId": "cn-hangzhou-i",
        "IntranetAddressSlaveZoneId": "cn-hangzhou-j",
        "IntranetAddressStatus": "ONLINE",
        "ConnectionZones": [
          "cn-hangzhou-i"
        ],
        "InternetAddressStatus": "CLOSED",
        "TransactionSplit": true,
        "AddressType": "MASTER"
      }
    ],
    "TenantZones": [
      {
        "TenantZoneId": "cn-hangzhou-i",
        "Region": "cn-hangzhou",
        "TenantZoneRole": "ReadOnly"
      }
    ],
    "ClogServiceStatus": "CLOSED",
    "EnableClogService": false,
    "Charset": "utf8mb4",
    "Collation": "utf8mb4_general_ci",
    "PrimaryZoneDeployType": "RANDOM",
    "MasterIntranetAddressZone": "cn-hangzhou-h",
    "PayType": "POSTPAY",
    "InstanceType": "KAFKA_PUBLIC",
    "Series": "normal",
    "DiskType": "cloud_essd_pl1",
    "AvailableZones": [
      "[\"cn-hangzhou-i\"]"
    ],
    "EnableReadWriteSplit": false,
    "EnableBinlogService": true
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-04-15The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2024-02-02The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-12-26The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-10-30The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-08-25The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-08-21The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-08-09The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-07-04The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-05-17The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-09-28The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2021-08-19Add Operationsee changesets