DescribeTenant - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud Documentation Center

Mengkueri informasi tentang penyewa tertentu dalam 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

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.	MySQL
VpcId	string	ID virtual private cloud (VPC). Jika tidak ada VPC yang sesuai, buat VPC dengan mengikuti instruksi di layar. Untuk informasi lebih lanjut, lihat Apa itu VPC?.	vpc-bp1d2q3mhg9i23ofi****
Status	string	Status penyewa. Nilai valid: ONLINE: Berjalan. PENDING_CREATE: Sedang dibuat. WAITING_ALLOCATE_MASTER_ADDRESS: (Siaga) Menunggu pembuatan alamat utama. ALLOCATING_MASTER_ADDRESS: Alamat utama sedang dibuat. DELETING_MASTER_ADDRESS: Alamat utama sedang dihapus. ALLOCATING_INTERNET_ADDRESS: Alamat jaringan publik sedang dibuat. PENDING_OFFLINE_INTERNET_ADDRESS: Alamat jaringan 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: Nama domain alamat sedang diubah. MODIFYING_PRIMARY_ZONE: Zona utama sedang dialihkan. MODIFYING_READONLY_ADDRESS: Alamat baca-saja sedang diubah. MODIFYING_READWRITE_ADDRESS: Alamat pemisahan baca/tulis sedang diubah. SPEC_MODIFYING: Spesifikasi sedang diubah. WHITE_LIST_MODIFYING: Daftar putih sedang diubah. CREATING_BINLOG: Log biner sedang dibuat.	ONLINE
EnableInternetAddressService	boolean	Apakah layanan alamat jaringan publik dapat diaktifkan untuk penyewa.	true
PrimaryZone	string	Zona utama penyewa.	cn-hangzhou-h
DeployType	string	Tipe penerapan kluster. Nilai valid: multiple: Penerapan multi-IDC. single: Penerapan single-IDC. dual: Penerapan dual-IDC.	multiple
DeployMode	string	Mode replika data penyewa. Untuk Edisi Ketersediaan Tinggi: N-N-N untuk tiga zona, dan N-N untuk dua zona atau zona tunggal. Untuk Edisi Dasar: N. 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	Pengatur waktu pembuatan penyewa.	2023-04-21 11:15:47.0
TenantResource	object	Informasi sumber daya penyewa.
UnitNum	integer	Jumlah unit dalam penyewa.	1
Cpu	object	Informasi sumber daya CPU penyewa.
UsedCpu	number	Jumlah core CPU yang digunakan oleh penyewa. Unit: Core.	8
TotalCpu	number	Jumlah total core CPU penyewa. Unit: Core.	10
UnitCpu	number	Jumlah core CPU per unit penyewa. Unit: Core.	8
Memory	object	Informasi sumber daya memori penyewa.
UsedMemory	number	Memori yang digunakan oleh penyewa. Unit: GB.	30
TotalMemory	number	Ukuran total memori penyewa. Unit: GB.	64
UnitMemory	number	Ukuran memori per unit penyewa. Unit: GB.	32
DiskSize	object	Informasi sumber daya disk penyewa.
UsedDiskSize	number	Ukuran disk yang digunakan oleh penyewa. Unit: GB.	86
CapacityUnit	object	Unit kapasitas.
MaxCapacityUnit	integer	Unit kapasitas maksimum.	16
MinCapacityUnit	integer	Unit kapasitas minimum.	1
UsedCapacit	integer	Unit kapasitas yang digunakan.	5
LogDiskSize	object	Informasi sumber daya log disk penyewa.
TotalLogDisk	integer	Ukuran total log disk yang dialokasikan untuk penyewa. Unit: GB.	8.0
UnitLogDisk	integer	Ukuran log disk yang dialokasikan per unit penyewa. Unit: GB.	8.0
TenantConnections	array<object>	Informasi koneksi penyewa.
	object	Informasi koneksi penyewa.
IntranetAddress	string	Titik akhir jaringan pribadi untuk mengakses penyewa.	t4nunwxr0****.oceanbase.aliyuncs.com
IntranetPort	integer	Port koneksi jaringan pribadi untuk mengakses penyewa.	2983
InternetAddress	string	Alamat koneksi jaringan publik untuk mengakses penyewa.	t4nunwxr0****-mi.oceanbase.aliyuncs.com
InternetPort	integer	Port koneksi jaringan publik untuk mengakses penyewa.	3306
VpcId	string	ID VPC.	vpc-bp1qiail1asmfe23t****
VSwitchId	string	ID vSwitch.	vsw-bp1i7b94u2et716yl****
IntranetAddressMasterZoneId	string	Zona aktif yang sesuai dengan titik akhir untuk mengakses penyewa.	cn-hangzhou-b
IntranetAddressSlaveZoneId	string	Zona sekunder yang sesuai dengan titik akhir untuk mengakses penyewa.	cn-hangzhou-g
IntranetAddressStatus	string	Status titik akhir jaringan pribadi untuk mengakses penyewa.	ONLINE
ConnectionZones	array	Daftar zona yang sesuai dengan koneksi penyewa.	["cn-hangzhou-i", "cn-hangzhou-j"]
	string	Zona yang sesuai dengan koneksi penyewa.	cn-hangzhou-b
InternetAddressStatus	string	Status koneksi jaringan publik untuk mengakses penyewa. Nilai valid: CLOSED: Ditutup. ALLOCATING_INTERNET_ADDRESS: Sedang dialokasikan. PENDING_OFFLINE_INTERNET_ADDRESS: Alamat jaringan publik sedang ditutup. ONLINE: Dalam layanan.	CLOSED
TransactionSplit	boolean	Apakah pemisahan transaksi diaktifkan.	false
AddressType	string	Tipe alamat. Nilai valid: MASTER: Alamat utama. Mendukung operasi baca dan tulis. READONLY: Alamat baca-saja. Hanya mendukung operasi baca. READWRITE: Alamat pemisahan baca/tulis. Secara otomatis memisahkan operasi baca dan tulis. CLOGSERVICE: Alamat layanan log transaksi. Valid values: MASTER : MASTER. READWRITE : READWRITE. CLOGSERVICE : CLOGSERVICE. READONLY : READONLY.	READONLY
EnableTransactionSplit	boolean	Apakah pemisahan transaksi diaktifkan.	false
ParallelQueryDegree	integer	Derajat paralelisme.	1
TenantEndpointId	string	ID titik akhir penyewa.	obe-4tw51gp7****
MaxConnectionNum	integer	Jumlah maksimum koneksi.	5000
ConnectionReplicaType	string	Tipe replika yang sesuai dengan koneksi.	FULL
ProxyClusterId	string	ID kluster ODP.	proxy-xxxxxxx
MaxConnectionLimit	integer	Nilai saat ini dari jumlah maksimum koneksi jaringan pribadi.	1000
InternetMaxConnectionLimit	integer	Batas atas jumlah maksimum koneksi jaringan publik.	4000
IntranetRpcPort	integer	Port impor bypass jaringan pribadi.	3307
InternetMaxConnectionNum	integer	Nilai saat ini dari jumlah maksimum koneksi jaringan publik.	2500
InternetRpcPort	integer	Port impor bypass jaringan publik.	3307
ConnectionLogicalZones	array	Zona logis tempat alamat berada.
	string	Informasi zona logis tempat alamat berada.	cn-bejing-3-z0,cn-bejing-4-z0
IntranetSqlPort	integer	Port SQL jaringan pribadi.	3306
OdpVersion	string	Versi ODP.	4.3.1-xxxxxxxxx
InternetSqlPort	integer	Port SQL jaringan publik.
InternetAddressServiceType	string	Tipe layanan alamat jaringan publik.
IntranetAddressServiceType	string	Tipe layanan alamat jaringan pribadi.
TenantZones	array<object>	Informasi zona penyewa.
	array<object>	Informasi zona penyewa.
TenantZoneId	string	ID zona penyewa.	cn-hangzhou-h
Region	string	Wilayah tempat zona penyewa berada.	cn-hangzhou
TenantZoneRole	string	Peran zona penyewa.	ReadWrite
TenantZoneReplicas	array<object>	Informasi replika zona penyewa.
	object	Informasi replika zona penyewa.
ZoneReplicaType	string	Tipe replika zona.	FULL
ZoneNodes	integer	Node zona.	1
LogicZoneName	string	Nama zona logis.	cn-shanghai-f-z0
ZoneCopyId	integer	ID replika zona.	2
FullCopyId	integer	ID replika fitur lengkap.	3
ReadOnlyCopyId	string	ID replika hanya baca.	3
ReadOnlyReplicaType	string	Tipe replika hanya baca.	ROW_STORE
ClogServiceStatus	string	Status aktif layanan Clog. Nilai valid: CLOSED: Dinonaktifkan. ONLINE: Aktif.	ONLINE
EnableClogService	boolean	Apakah layanan Clog tersedia. Untuk mengaktifkan layanan ini, kirimkan Tiket.	true
Charset	string	Set karakter.	gb18030
Collation	string	Aturan pengurutan.	gb18030_chinese_ci
PrimaryZoneDeployType	string	Tipe penerapan zona utama penyewa. Valid values: RANDOM : RANDOM. STATIC : STATIC.	STATIC
MasterIntranetAddressZone	string	Zona tempat node master berada.	cn-hangzhou-h
PayType	string	Metode penagihan.	POSTPAY
InstanceType	string	Tipe instans.	KAFKA_PUBLIC
Series	string	Edisi instans.	normal
DiskType	string	Tipe disk.	cloud_essd_pl1
AvailableZones	array	Daftar zona.
	string	Daftar zona.	["cn-hangzhou-i"]
EnableReadWriteSplit	boolean	Apakah pengaktifan alamat pemisahan baca/tulis diizinkan.	true
EnableParallelQuery	boolean	Apakah pengaktifan kueri paralel diizinkan.	true
MaxParallelQueryDegree	integer	Batas atas pengaturan derajat paralelisme.	32
EnableBinlogService	boolean	Apakah permintaan layanan Binlog dapat dilakukan.	true
TimeZone	string	Zona waktu.	Asia/Shanghai
DataMergeTime	string	Waktu penggabungan penyewa. Parameter ini hanya didukung untuk OceanBase V4.0.0 dan yang lebih baru.	02:36Z
ReadOnlyResource	object	Informasi Sumber daya baca-saja.
UnitNum	integer	Jumlah unit dalam penyewa.	2
Cpu	object	CPU setiap node replika dalam kluster. Unit: core.
UsedCpu	number	CPU yang digunakan oleh kluster. Unit: core.	8
TotalCpu	number	Jumlah total core CPU penyewa. Unit: Core.	10
UnitCpu	number	Jumlah core CPU per unit penyewa. Unit: Core.	8
Memory	object	Informasi memori kluster.
UsedMemory	number	Memori yang digunakan oleh penyewa. Unit: GB.	30
TotalMemory	number	Ukuran total memori penyewa. Unit: GB.	64
UnitMemory	number	Ukuran memori setiap unit penyewa. Unit: GB.	32
DiskSize	object	Spesifikasi ukuran disk data.
UsedDiskSize	number	Ukuran disk yang digunakan oleh penyewa. Unit: GB.	86
CapacityUnit	object	Informasi unit kapasitas.
MaxCapacityUnit	integer	Unit kapasitas maksimum.	16
MinCapacityUnit	integer	Unit kapasitas minimum.	1
UsedCapacit	integer	Unit kapasitas yang digunakan.	5
LogDiskSize	object	Informasi ukuran disk log.
TotalLogDisk	integer	Total ukuran disk log. Unit: GB.	8.0
UnitLogDisk	integer	Unit disk log.	8.0
EnableReadOnlyReplica	boolean	Apakah replika baca-saja didukung.	true
RecycleBinStatus	string	Status keranjang daur ulang penyewa. ON menunjukkan diaktifkan dan OFF menunjukkan dinonaktifkan.	ON
LowerCaseTableNames	integer	Apakah nama tabel peka huruf besar-kecil. Nilai valid:	1
Version	string	Informasi versi.	4.2.1
OdpVersion	string	Versi ODP.	4.3.1-xxxxxxxxx
TenantMaxConnections	integer	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.