All Products
Search
Document Center

ApsaraDB for OceanBase (Deprecated):DescribeTenant

Last Updated:Jun 12, 2026

Menampilkan informasi penyewa tertentu di kluster tertentu.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeTenant

get

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

ID kluster OceanBase.

ob317v4uif****

TenantId

string

Yes

ID penyewa.

t4pnum****

Elemen respons

Element

Type

Description

Example

object

Informasi detail tentang penyewa.

RequestId

string

ID permintaan.

EE205C00-30E4-****-****-87E3A8A2AA0C

Tenant

object

Informasi penyewa.

TenantId

string

ID penyewa.

t4louaeei****

TenantName

string

Nama penyewa.

forMySQLTenant

TenantMode

string

Mode penyewa.
Nilai yang saat ini didukung:

  • Oracle: Mode Oracle.

  • MySQL: Mode MySQL.

MySQL

VpcId

string

ID Virtual Private Cloud (VPC). Jika tidak ada VPC yang sesuai, buat VPC dengan mengikuti petunjuk di layar. Untuk informasi lebih lanjut, lihat Apa itu VPC.

vpc-bp1d2q3mhg9i23ofi****

Status

string

Status penyewa:

  • ONLINE: Berjalan.

  • PENDING_CREATE: Sedang dibuat.

  • WAITING_ALLOCATE_MASTER_ADDRESS: (Standby) Menunggu pembuatan alamat utama.

  • ALLOCATING_MASTER_ADDRESS: Alamat utama sedang dibuat.

  • DELETING_MASTER_ADDRESS: Alamat utama sedang dihapus.

  • ALLOCATING_INTERNET_ADDRESS: Alamat IP publik sedang dibuat.

  • PENDING_OFFLINE_INTERNET_ADDRESS: Alamat IP publik sedang dihapus.

  • ALLOCATING_READONLY_ADDRESS: Alamat baca-saja sedang dibuat.

  • DELETING_READONLY_ADDRESS: Alamat baca-saja sedang dihapus.

  • ALLOCATING_READWRITE_ADDRESS: Alamat pemisahan baca-tulis sedang dibuat.

  • DELETING_READWRITE_ADDRESS: Alamat pemisahan baca-tulis sedang dihapus.

  • ALLOCATING_CLOGSERVICE_ADDRESS: Alamat log transaksi sedang dibuat.

  • DELETING_CLOGSERVICE_ADDRESS: Alamat log transaksi sedang dihapus.

  • MODIFYING_ADDRESS: Domain alamat sedang dimodifikasi.

  • MODIFYING_PRIMARY_ZONE: Zona utama sedang dialihkan.

  • MODIFYING_READONLY_ADDRESS: Alamat baca-saja sedang dimodifikasi.

  • MODIFYING_READWRITE_ADDRESS: Alamat pemisahan baca-tulis sedang dimodifikasi.

  • SPEC_MODIFYING: Spesifikasi sedang dimodifikasi.

  • WHITE_LIST_MODIFYING: Daftar putih sedang dimodifikasi.

  • CREATING_BINLOG: Binlog sedang dibuat.

ONLINE

EnableInternetAddressService

boolean

Apakah alamat IP publik untuk penyewa dapat diaktifkan.

true

PrimaryZone

string

Zona utama penyewa.

cn-hangzhou-h

DeployType

string

Tipe penyebaran kluster.

  • multiple: Multi-IDC.

  • single: Single-IDC.

  • dual: Dual-IDC.

multiple

DeployMode

string

Mode replika data penyewa.

  • Untuk Edisi Ketersediaan tinggi: N-N-N untuk tiga wilayah, N-N untuk dua zona atau satu zona.

  • Untuk Edisi Dasar: N.

Catatan


N mewakili jumlah node dalam zona tunggal.

FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j

Description

string

Deskripsi penyewa.

paycore database

CreateTime

string

Waktu pembuatan penyewa.

2023-04-21 11:15:47.0

TenantResource

object

Informasi resource penyewa.

UnitNum

integer

The number of resource units for the tenant.

1

Cpu

object

The information about the CPU resources of the tenant.

UsedCpu

number

The number of used CPU cores of the tenant.

8

TotalCpu

number

The total number of CPU cores of the tenant.

10

UnitCpu

number

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

8

Memory

object

The information about the memory resources of the tenant.

UsedMemory

number

The size of used memory of the tenant, in GB.

30

TotalMemory

number

The total memory size of the tenant, in GB.

64

UnitMemory

number

The memory size of each resource unit of the tenant, in GB.

32

DiskSize

object

The information about the disk resources of the tenant.

UsedDiskSize

number

The size of used disk space of the tenant, in GB.

86

CapacityUnit

object

The information about capacity units.

MaxCapacityUnit

integer

The maximum number of capacity units.

16

MinCapacityUnit

integer

The minimum number of capacity units.

1

UsedCapacit

integer

The number of used capacity units.

5

LogDiskSize

object

The information about the log disk resources of the tenant.

TotalLogDisk

integer

The total size of log disk of the tenant, in GB.

8.0

UnitLogDisk

integer

The log disk size of each resource unit of the tenant, in GB.

8.0

TenantConnections

array<object>

Informasi koneksi penyewa.

object

Informasi koneksi penyewa.

IntranetAddress

string

The intranet address for accessing the tenant.

t4nunwxr0****.oceanbase.aliyuncs.com

IntranetPort

integer

The intranet port for accessing the tenant.

2983

InternetAddress

string

The Internet address for accessing the tenant.

t4nunwxr0****-mi.oceanbase.aliyuncs.com

InternetPort

integer

The Internet port for accessing the tenant.

3306

VpcId

string

The ID of the VPC.

vpc-bp1qiail1asmfe23t****

VSwitchId

string

The ID of the vSwitch.

vsw-bp1i7b94u2et716yl****

IntranetAddressMasterZoneId

string

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

cn-hangzhou-b

IntranetAddressSlaveZoneId

string

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

cn-hangzhou-g

IntranetAddressStatus

string

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

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 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.

CLOSED

TransactionSplit

boolean

Specifies whether to enable transaction splitting.

false

AddressType

string

The type of the address.

  • MASTER: the primary address, which supports both data read and write.

  • READONLY: a read-only address.

  • READWRITE: a read/write splitting address.

  • CLOGSERVICE: a clog service address.

Valid values:

  • MASTER :

    MASTER

  • READWRITE :

    READWRITE

  • CLOGSERVICE :

    CLOGSERVICE

  • READONLY :

    READONLY

READONLY

EnableTransactionSplit

boolean

Specifies whether to enable transaction splitting.

false

ParallelQueryDegree

integer

The degree of parallelism (DOP).

1

TenantEndpointId

string

The ID of the tenant endpoint.

obe-4tw51gp7****

MaxConnectionNum

integer

The maximum number of connections.

5000

ConnectionReplicaType

string

The type of the replica corresponding to the tenant connection.

FULL

ProxyClusterId

string

The ID of the OceanBase Database Proxy (ODP) cluster.

proxy-xxxxxxx

MaxConnectionLimit

integer

The current value set for the maximum number of private connections.

1000

InternetMaxConnectionLimit

integer

The upper limit of the maximum number of public connections.

4000

IntranetRpcPort

integer

The port for direct loads of private connections.

3307

InternetMaxConnectionNum

integer

The current value set for the maximum number of public connections.

2500

InternetRpcPort

integer

The port for direct loads of public connections.

3307

ConnectionLogicalZones

array

The logical zones of the endpoints.

string

The logical zones of the endpoints.

cn-bejing-3-z0,cn-bejing-4-z0

IntranetSqlPort

integer

The port of private SQL connections.

3306

OdpVersion

string

The ODP version.

4.3.1-xxxxxxxxx

InternetSqlPort

integer

InternetAddressServiceType

string

IntranetAddressServiceType

string

TenantZones

array<object>

Informasi zona penyewa.

array<object>

Informasi zona penyewa.

TenantZoneId

string

The ID of the zone.

cn-hangzhou-h

Region

string

The region where the zone of the tenant resides.

cn-hangzhou

TenantZoneRole

string

The role of the zone of the tenant.

ReadWrite

TenantZoneReplicas

array<object>

The zone replicas of the tenant.

object

The zone replicas of the tenant.

ZoneReplicaType

string

The type of the zone replica.

FULL

ZoneNodes

integer

The number of nodes in the zone.

1

LogicZoneName

string

The name of the logical zone.

cn-shanghai-f-z0

ZoneCopyId

integer

The ID of the zone replica.

2

FullCopyId

integer

The ID of the full-featured replica.

3

ReadOnlyCopyId

string

The ID of the read-only replica.

3

ReadOnlyReplicaType

string

The type of the read-only replica.

ROW_STORE

ClogServiceStatus

string

Status layanan Clog.

  • CLOSED: Ditutup.

  • ONLINE: Dalam layanan.

ONLINE

EnableClogService

boolean

Apakah layanan Clog dapat digunakan. Untuk mengaktifkannya, kirim tiket.

true

Charset

string

Set karakter.

gb18030

Collation

string

Aturan pengurutan.

gb18030_chinese_ci

PrimaryZoneDeployType

string

Mode penyebaran zona utama penyewa.

Valid values:

  • RANDOM :

    RANDOM.

  • STATIC :

    STATIC.

STATIC

MasterIntranetAddressZone

string

Zona node master.

cn-hangzhou-h

PayType

string

Metode penagihan.

POSTPAY

InstanceType

string

Tipe instans.

KAFKA_PUBLIC

Series

string

Seri instans.

normal

DiskType

string

Tipe disk.

cloud_essd_pl1

AvailableZones

array

Daftar zona yang tersedia.

string

Daftar zona yang tersedia.

["cn-hangzhou-i"]

EnableReadWriteSplit

boolean

Apakah alamat pemisahan baca-tulis dapat diaktifkan.

true

EnableParallelQuery

boolean

Apakah kueri paralel dapat diaktifkan.

true

MaxParallelQueryDegree

integer

Tingkat paralelisme maksimum.

32

EnableBinlogService

boolean

Apakah layanan Binlog dapat diaktifkan.

true

TimeZone

string

Zona waktu.

Asia/Shanghai

DataMergeTime

string

Waktu penggabungan penyewa. Hanya didukung untuk OceanBase V4.0.0 dan versi yang lebih baru.

02:36Z

ReadOnlyResource

object

Informasi Sumber daya baca-saja.

UnitNum

integer

The number of resource units in the tenant.

2

Cpu

object

The number of CPU cores of each replica node in the cluster.

UsedCpu

number

The number of CPU cores used by the cluster.

8

TotalCpu

number

The total number of CPU cores of the tenant.

10

UnitCpu

number

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

8

Memory

object

The information about the memory resources of the cluster.

UsedMemory

number

The size of memory used by the tenant, in GB.

30

TotalMemory

number

The total memory size of the tenant, in GB.

64

UnitMemory

number

The memory size of each resource unit of the tenant, in GB.

32

DiskSize

object

The size of the data disk.

UsedDiskSize

number

The size of disk space used by the tenant, in GB.

86

CapacityUnit

object

The information about capacity units.

MaxCapacityUnit

integer

The maximum number of capacity units.

16

MinCapacityUnit

integer

The minimum number of capacity units.

1

UsedCapacit

integer

The number of used capacity units.

5

LogDiskSize

object

The information about the log disk resources of the tenant.

TotalLogDisk

integer

The total log disk size of the tenant, in GB.

8.0

UnitLogDisk

integer

The log disk size of each resource unit of the tenant, in GB.

8.0

EnableReadOnlyReplica

boolean

Apakah replika baca-saja didukung.

true

RecycleBinStatus

string

Status keranjang daur ulang penyewa. ON menunjukkan diaktifkan. OFF menunjukkan dinonaktifkan.

ON

LowerCaseTableNames

integer

Apakah nama tabel peka huruf besar/kecil. Nilai valid:

  • 1: Tidak peka huruf besar/kecil.

  • 0: Peka huruf besar/kecil.

1

Version

string

Informasi versi.

4.2.1

OdpVersion

string

Versi ODP.

4.3.1-xxxxxxxxx

TenantMaxConnections

string

Jumlah koneksi maksimum yang diizinkan untuk penyewa.

1600

ParameterTemplate

string

Template parameter.

express_oltp

Iops

integer

IOPS penyewa.

10000

Contoh

Respons sukses

JSONformat

{
  "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
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.