DescribeTenant - 查詢指定叢集下的指定租戶資訊 - ApsaraDB for OceanBase (Deprecated)

查看指定叢集下的指定租戶資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeTenant

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	OceanBase 叢集 ID。	ob317v4uif****
TenantId	string	是	租戶 ID。	t4pnum****

返回參數

名稱	類型	描述	樣本值
	object	租戶的詳細資料。
RequestId	string	請求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Tenant	object	租戶資訊。
TenantId	string	租戶 ID。	t4louaeei****
TenantName	string	租戶名稱。	forMySQLTenant
TenantMode	string	租戶模式。當前支援： Oracle：Oracle 模式。 MySQL: MySQL 模式。	MySQL
VpcId	string	Virtual Private Cloud ID。如無合適的 VPC，請根據頁面提示建立一個 VPC，詳情參見什麼是專用網路。	vpc-bp1d2q3mhg9i23ofi****
Status	string	租戶狀態： ONLINE：運行中。 PENDING_CREATE：建立中。 WAITING_ALLOCATE_MASTER_ADDRESS：（備庫）等待建立主地址。 ALLOCATING_MASTER_ADDRESS：主地址建立中。 DELETING_MASTER_ADDRESS：主地址刪除中。 ALLOCATING_INTERNET_ADDRESS：公網地址建立中。 PENDING_OFFLINE_INTERNET_ADDRESS：公網地址刪除中。 ALLOCATING_READONLY_ADDRESS：唯讀地址建立中。 DELETING_READONLY_ADDRESS：唯讀地址刪除中。 ALLOCATING_READWRITE_ADDRESS：讀寫分離地址建立中。 DELETING_READWRITE_ADDRESS：讀寫分離地址刪除中。 ALLOCATING_CLOGSERVICE_ADDRESS：交易記錄地址建立中。 DELETING_CLOGSERVICE_ADDRESS：交易記錄地址刪除中。 MODIFYING_ADDRESS：地址網域名稱修改中。 MODIFYING_PRIMARY_ZONE：主可用性區域切換中。 MODIFYING_READONLY_ADDRESS：唯讀地址修改中。 MODIFYING_READWRITE_ADDRESS：讀寫分離地址修改中。 SPEC_MODIFYING：規格修改中。 WHITE_LIST_MODIFYING：白名單修改中。 CREATING_BINLOG：Binlog 建立中。	ONLINE
EnableInternetAddressService	boolean	是否可開啟租戶公網地址。	true
PrimaryZone	string	租戶的主可用性區域。	cn-hangzhou-h
DeployType	string	叢集的部署類型。 multiple：多機房。 single：單機房。 dual：雙機房。	multiple
DeployMode	string	租戶的資料副本模式。對於高可用版本：三地區為 N-N-N，兩可用性區域和單可用性區域均為 N-N；對於基礎版為 N。說明其中 N 為單可用性區域內的節點數。	FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j
Description	string	租戶描述資訊。	paycore database
CreateTime	string	租戶的建立時間。	2023-04-21 11:15:47.0
TenantResource	object	租戶的資源資訊。
UnitNum	integer	租戶的 unit 個數。	1
Cpu	object	租戶的 CPU 資源資訊。
UsedCpu	number	租戶已使用的 CPU 核心數，單位：Core。	8
TotalCpu	number	租戶總的 CPU 核心數，單位：Core。	10
UnitCpu	number	租戶每個 Unit 的 CPU 核心數，單位：Core。	8
Memory	object	租戶記憶體資源資訊。
UsedMemory	number	租戶已使用的記憶體，單位：GB。	30
TotalMemory	number	租戶總的記憶體大小，單位：GB。	64
UnitMemory	number	租戶每個 Unit 的記憶體大小，單位：GB。	32
DiskSize	object	租戶磁碟資源資訊。
UsedDiskSize	number	租戶已使用的磁碟大小，單位：GB。	86
CapacityUnit	object	容量單元。
MaxCapacityUnit	integer	最大容量單元。	16
MinCapacityUnit	integer	最小容量單元。	1
UsedCapacit	integer	已使用容量單元。	5
LogDiskSize	object	租戶日誌盤資源資訊。
TotalLogDisk	integer	租戶總的日誌盤分配大小，單位：GB。	8.0
UnitLogDisk	integer	租戶每個 Unit 的日誌盤分配大小，單位：GB。	8.0
TenantConnections	array<object>	租戶的串連資訊。
	object	租戶的串連資訊。
IntranetAddress	string	訪問租戶的私網串連地址。	t4nunwxr0****.oceanbase.aliyuncs.com
IntranetPort	integer	訪問租戶的私網串連連接埠。	2983
InternetAddress	string	訪問租戶的公網串連地址。	t4nunwxr0****-mi.oceanbase.aliyuncs.com
InternetPort	integer	訪問租戶的公網串連連接埠。	3306
VpcId	string	Virtual Private CloudID。	vpc-bp1qiail1asmfe23t****
VSwitchId	string	虛擬交換器（VSwitch）ID。	vsw-bp1i7b94u2et716yl****
IntranetAddressMasterZoneId	string	訪問租戶的串連地址對應的主可用性區域。	cn-hangzhou-b
IntranetAddressSlaveZoneId	string	訪問租戶的串連地址對應的備可用性區域。	cn-hangzhou-g
IntranetAddressStatus	string	訪問租戶的私網串連地址狀態。 ONLINE: 服務中。	ONLINE
ConnectionZones	array	租戶串連對應的訪問可用性區域列表。	["cn-hangzhou-i", "cn-hangzhou-j"]
	string	租戶串連對應的可用性區域。	cn-hangzhou-b
InternetAddressStatus	string	訪問租戶的公網串連開通狀態。 CLOSED：關閉。 ALLOCATING_INTERNET_ADDRESS：申請中。 PENDING_OFFLINE_INTERNET_ADDRESS: 公網地址關閉中。 ONLINE：服務中。	CLOSED
TransactionSplit	boolean	是否開啟事務拆分。	false
AddressType	string	地址類型。 MASTER：主地址，可讀可寫。 READONLY：唯讀地址，唯讀。 READWRITE：讀寫分離地址，自動讀寫分離。 CLOGSERVICE：交易記錄服務地址。枚舉值： MASTER : MASTER READWRITE : READWRITE CLOGSERVICE : CLOGSERVICE READONLY : READONLY	READONLY
EnableTransactionSplit	boolean	是否開啟事務拆分。	false
ParallelQueryDegree	integer	並行度。	1
TenantEndpointId	string	租戶地址 ID。	obe-4tw51gp7****
MaxConnectionNum	integer	最大串連數。	5000
ConnectionReplicaType	string	連結對應的副本類型。	FULL
ProxyClusterId	string	ODP 叢集 ID。	proxy-xxxxxxx
MaxConnectionLimit	integer	私網最大串連數的當前值	1000
InternetMaxConnectionLimit	integer	公網最大串連數的上限	4000
IntranetRpcPort	integer	私網旁路匯入連接埠	3307
InternetMaxConnectionNum	integer	公網最大串連數的當前值	2500
InternetRpcPort	integer	公網旁路匯入連接埠	3307
ConnectionLogicalZones	array	地址所在的邏輯 zone
	string	地址所在的邏輯 zone 資訊	cn-bejing-3-z0,cn-bejing-4-z0
IntranetSqlPort	integer	私網 SQL 連接埠	3306
OdpVersion	string	ODP 版本	4.3.1-xxxxxxxxx
InternetSqlPort	integer	公網 sql 連接埠
InternetAddressServiceType	string	公網地址地址類型
IntranetAddressServiceType	string	私網地址地址類型
TenantZones	array<object>	租戶的可用性區域資訊。
	array<object>	租戶的可用性區域資訊。
TenantZoneId	string	租戶可用性區域 ID。	cn-hangzhou-h
Region	string	租戶可用性區域所屬的地區。	cn-hangzhou
TenantZoneRole	string	租戶可用性區域的角色。	ReadWrite
TenantZoneReplicas	array<object>	租戶可用性區域副本資訊。
	object	租戶可用性區域副本資訊。
ZoneReplicaType	string	可用性區域副本類型。	FULL
ZoneNodes	integer	可用性區域節點。	1
LogicZoneName	string	邏輯可用性區域名稱。	cn-shanghai-f-z0
ZoneCopyId	integer	可用性區域複本識別碼。	2
FullCopyId	integer	全功能複本識別碼。	3
ReadOnlyCopyId	string	唯讀複本識別碼。	3
ReadOnlyReplicaType	string	唯讀副本類型。	ROW_STORE
ClogServiceStatus	string	Clog 服務開啟狀態。 CLOSED: 關閉。 ONLINE：服務中。	ONLINE
EnableClogService	boolean	是否可使用 Clog 服務，如需開啟，請工單聯絡。	true
Charset	string	字元集。	gb18030
Collation	string	字元序。	gb18030_chinese_ci
PrimaryZoneDeployType	string	租戶主可用性區域部署模式。枚舉值： RANDOM : RANDOM STATIC : STATIC	STATIC
MasterIntranetAddressZone	string	Master 節點所在可用性區域。	cn-hangzhou-h
PayType	string	付費類型。	POSTPAY
InstanceType	string	執行個體類型。	KAFKA_PUBLIC
Series	string	執行個體系列。	normal
DiskType	string	磁碟類型。	cloud_essd_pl1
AvailableZones	array	可用性區域列表資訊。
	string	可用性區域列表資訊。	["cn-hangzhou-i"]
EnableReadWriteSplit	boolean	是否允許開啟讀寫分離地址。	true
EnableParallelQuery	boolean	是否允許開通並行查詢。	true
MaxParallelQueryDegree	integer	並行度設定上限。	32
EnableBinlogService	boolean	是否可以申請 Binlog 服務。	true
TimeZone	string	時區。	Asia/Shanghai
DataMergeTime	string	租戶合并時間，僅支援 OceanBase V4.0.0 及之後的版本。	02:36Z
ReadOnlyResource	object	唯讀資源資訊。
UnitNum	integer	租戶的 unit 個數。	2
Cpu	object	叢集中每個副本節點的 CPU，單位：Core。
UsedCpu	number	叢集已使用的 CPU，單位：Core。	8
TotalCpu	number	租戶總的 CPU 核心數，單位：Core。	10
UnitCpu	number	租戶每個 Unit 的 CPU 核心數，單位：Core。	8
Memory	object	叢集記憶體資訊。
UsedMemory	number	租戶已使用的記憶體，單位：GB。	30
TotalMemory	number	租戶總的記憶體大小，單位：GB。	64
UnitMemory	number	租戶每個 Unit 的記憶體大小，單位：GB。	32
DiskSize	object	資料盤大小規格。
UsedDiskSize	number	租戶已使用的磁碟大小，單位：GB。	86
CapacityUnit	object	容量單元資訊。
MaxCapacityUnit	integer	最大容量單元。	16
MinCapacityUnit	integer	最小容量單元。	1
UsedCapacit	integer	已使用容量單元。	5
LogDiskSize	object	日誌盤大小資訊。
TotalLogDisk	integer	總日誌盤大小，單位：GB。	8.0
UnitLogDisk	integer	日誌盤單元。	8.0
EnableReadOnlyReplica	boolean	是否支援唯讀副本	true
RecycleBinStatus	string	表示租戶資源回收筒狀態，ON 表示開啟，OFF 表示關閉	ON
LowerCaseTableNames	integer	表名是否區分大小寫，取值範圍如下： 1：不區分大小寫 0：區分大小寫	1
Version	string	版本資訊	4.2.1
OdpVersion	string	ODP 版本	4.3.1-xxxxxxxxx
TenantMaxConnections	integer	租戶允許的最大串連數	1600
ParameterTemplate	string	參數模板	express_oltp
Iops	integer	租戶 IOPS	10000

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。