Consulta as informações sobre um tenant especificado em um cluster especificado.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
oceanbase:DescribeTenant |
get |
*全部资源
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| InstanceId |
string |
Sim |
O ID do cluster OceanBase. |
ob317v4uif**** |
| TenantId |
string |
Sim |
O ID do tenant. |
t4pnum**** |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
As informações detalhadas sobre o tenant. |
||
| RequestId |
string |
O ID da solicitação. |
EE205C00-30E4-****-****-87E3A8A2AA0C |
| Tenant |
object |
As informações do tenant. |
|
| TenantId |
string |
O ID do tenant. |
t4louaeei**** |
| TenantName |
string |
O nome do tenant. |
forMySQLTenant |
| TenantMode |
string |
O modo do tenant. |
MySQL |
| VpcId |
string |
O ID da nuvem privada virtual (VPC). Se nenhuma VPC adequada estiver disponível, crie uma seguindo as instruções na tela. Para mais informações, consulte O que é uma VPC?. |
vpc-bp1d2q3mhg9i23ofi**** |
| Status |
string |
O status do tenant. Valores válidos:
|
ONLINE |
| EnableInternetAddressService |
boolean |
Indica se o serviço de endereço de rede pública pode ser ativado para o tenant. |
true |
| PrimaryZone |
string |
A zona primária do tenant. |
cn-hangzhou-h |
| DeployType |
string |
O tipo de implantação do cluster. Valores válidos:
|
multiple |
| DeployMode |
string |
O modo de réplica de dados do tenant. Para a edição de alta disponibilidade: N-N-N para três zonas e N-N para duas zonas ou zona única. Para a edição básica: N. N representa o número de nós em uma única zona. |
FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j |
| Description |
string |
A descrição do tenant. |
paycore database |
| CreateTime |
string |
A hora de criação do tenant. |
2023-04-21 11:15:47.0 |
| TenantResource |
object |
As informações de recursos do tenant. |
|
| UnitNum |
integer |
O número de unidades no tenant. |
1 |
| Cpu |
object |
As informações de recursos de CPU do tenant. |
|
| UsedCpu |
number |
O número de núcleos de CPU usados pelo tenant. Unidade: Núcleo. |
8 |
| TotalCpu |
number |
O número total de núcleos de CPU do tenant. Unidade: Núcleo. |
10 |
| UnitCpu |
number |
O número de núcleos de CPU por unidade do tenant. Unidade: Núcleo. |
8 |
| Memory |
object |
As informações de recursos de memória do tenant. |
|
| UsedMemory |
number |
A memória usada pelo tenant. Unidade: GB. |
30 |
| TotalMemory |
number |
O tamanho total de memória do tenant. Unidade: GB. |
64 |
| UnitMemory |
number |
O tamanho de memória por unidade do tenant. Unidade: GB. |
32 |
| DiskSize |
object |
As informações de recursos de disco do tenant. |
|
| UsedDiskSize |
number |
O tamanho de disco usado pelo tenant. Unidade: GB. |
86 |
| CapacityUnit |
object |
A unidade de capacidade. |
|
| MaxCapacityUnit |
integer |
A unidade de capacidade máxima. |
16 |
| MinCapacityUnit |
integer |
A unidade de capacidade mínima. |
1 |
| UsedCapacit |
integer |
A unidade de capacidade usada. |
5 |
| LogDiskSize |
object |
As informações de recursos de disco de log do tenant. |
|
| TotalLogDisk |
integer |
O tamanho total do disco de log alocado ao tenant. Unidade: GB. |
8.0 |
| UnitLogDisk |
integer |
O tamanho do disco de log alocado por unidade do tenant. Unidade: GB. |
8.0 |
| TenantConnections |
array<object> |
As informações de conexão do tenant. |
|
|
object |
As informações de conexão do tenant. |
||
| IntranetAddress |
string |
O endpoint de rede privada para acessar o tenant. |
t4nunwxr0****.oceanbase.aliyuncs.com |
| IntranetPort |
integer |
A porta de conexão de rede privada para acessar o tenant. |
2983 |
| InternetAddress |
string |
O endereço de conexão de rede pública para acessar o tenant. |
t4nunwxr0****-mi.oceanbase.aliyuncs.com |
| InternetPort |
integer |
A porta de conexão de rede pública para acessar o tenant. |
3306 |
| VpcId |
string |
O ID da nuvem privada virtual (VPC). |
vpc-bp1qiail1asmfe23t**** |
| VSwitchId |
string |
O ID do vSwitch. |
vsw-bp1i7b94u2et716yl**** |
| IntranetAddressMasterZoneId |
string |
A zona ativa correspondente ao endpoint para acessar o tenant. |
cn-hangzhou-b |
| IntranetAddressSlaveZoneId |
string |
A zona secundária correspondente ao endpoint para acessar o locatário. |
cn-hangzhou-g |
| IntranetAddressStatus |
string |
O status do endpoint de rede privada para acessar o locatário. |
ONLINE |
| ConnectionZones |
array |
A lista de zonas correspondentes à conexão do locatário. |
["cn-hangzhou-i", "cn-hangzhou-j"] |
|
string |
A zona correspondente à conexão do locatário. |
cn-hangzhou-b |
|
| InternetAddressStatus |
string |
O status da conexão de rede pública para acessar o tenant. Valores válidos:
|
CLOSED |
| TransactionSplit |
boolean |
Indica se a divisão de transações está ativada. |
false |
| AddressType |
string |
O tipo de endereço. Valores válidos:
Valores válidos:
|
READONLY |
| EnableTransactionSplit |
boolean |
Indica se a divisão de transações está ativada. |
false |
| ParallelQueryDegree |
integer |
O grau de paralelismo. |
1 |
| TenantEndpointId |
string |
O ID do endpoint do locatário. |
obe-4tw51gp7**** |
| MaxConnectionNum |
integer |
O número máximo de conexões. |
5000 |
| ConnectionReplicaType |
string |
O tipo de réplica correspondente à conexão. |
FULL |
| ProxyClusterId |
string |
O ID do cluster ODP. |
proxy-xxxxxxx |
| MaxConnectionLimit |
integer |
O valor atual do número máximo de conexões de rede privada. |
1000 |
| InternetMaxConnectionLimit |
integer |
O limite superior do número máximo de conexões de rede pública. |
4000 |
| IntranetRpcPort |
integer |
A porta de importação de bypass de rede privada. |
3307 |
| InternetMaxConnectionNum |
integer |
O valor atual do número máximo de conexões de rede pública. |
2500 |
| InternetRpcPort |
integer |
A porta de importação de bypass de rede pública. |
3307 |
| ConnectionLogicalZones |
array |
As zonas lógicas onde o endereço está localizado. |
|
|
string |
As informações da zona lógica onde o endereço está localizado. |
cn-bejing-3-z0,cn-bejing-4-z0 |
|
| IntranetSqlPort |
integer |
A porta SQL de rede privada. |
3306 |
| OdpVersion |
string |
A versão do ODP. |
4.3.1-xxxxxxxxx |
| InternetSqlPort |
integer |
A porta SQL de rede pública. |
|
| InternetAddressServiceType |
string |
O tipo de serviço do endereço de rede pública. |
|
| IntranetAddressServiceType |
string |
O tipo de serviço do endereço de rede privada. |
|
| TenantZones |
array<object> |
As informações de zona do locatário. |
|
|
array<object> |
As informações de zona do locatário. |
||
| TenantZoneId |
string |
O ID da zona do locatário. |
cn-hangzhou-h |
| Region |
string |
A região à qual a zona do locatário pertence. |
cn-hangzhou |
| TenantZoneRole |
string |
A função da zona do locatário. |
ReadWrite |
| TenantZoneReplicas |
array<object> |
As informações de réplica da zona do locatário. |
|
|
object |
As informações de réplica da zona do locatário. |
||
| ZoneReplicaType |
string |
O tipo de réplica da zona. |
FULL |
| ZoneNodes |
integer |
Os nós da zona. |
1 |
| LogicZoneName |
string |
O nome da zona lógica. |
cn-shanghai-f-z0 |
| ZoneCopyId |
integer |
O ID da réplica da zona. |
2 |
| FullCopyId |
integer |
O ID da réplica completa. |
3 |
| ReadOnlyCopyId |
string |
O ID da réplica somente leitura. |
3 |
| ReadOnlyReplicaType |
string |
O tipo de réplica somente leitura. |
ROW_STORE |
| ClogServiceStatus |
string |
O status de ativação do serviço Clog. Valores válidos:
|
ONLINE |
| EnableClogService |
boolean |
Indica se o serviço Clog está disponível. Para ativar este serviço, envie um ticket. |
true |
| Charset |
string |
O conjunto de caracteres. |
gb18030 |
| Collation |
string |
A collation. |
gb18030_chinese_ci |
| PrimaryZoneDeployType |
string |
O tipo de implantação da zona primária do locatário. Valores válidos:
|
STATIC |
| MasterIntranetAddressZone |
string |
A zona onde o nó master está localizado. |
cn-hangzhou-h |
| PayType |
string |
O método de cobrança. |
POSTPAY |
| InstanceType |
string |
O tipo de instância. |
KAFKA_PUBLIC |
| Series |
string |
A edição da instância. |
normal |
| DiskType |
string |
O tipo de disco. |
cloud_essd_pl1 |
| AvailableZones |
array |
A lista de zonas. |
|
|
string |
A lista de zonas. |
["cn-hangzhou-i"] |
|
| EnableReadWriteSplit |
boolean |
Indica se o endereço de divisão de leitura/gravação pode ser ativado. |
true |
| EnableParallelQuery |
boolean |
Indica se a consulta paralela pode ser ativada. |
true |
| MaxParallelQueryDegree |
integer |
O limite superior da configuração do grau de paralelismo. |
32 |
| EnableBinlogService |
boolean |
Indica se o serviço Binlog pode ser solicitado. |
true |
| TimeZone |
string |
O fuso horário. |
Asia/Shanghai |
| DataMergeTime |
string |
A hora de mesclagem do tenant. Este parâmetro é suportado apenas no OceanBase V4.0.0 e versões posteriores. |
02:36Z |
| ReadOnlyResource |
object |
As informações de recursos somente leitura. |
|
| UnitNum |
integer |
O número de unidades no tenant. |
2 |
| Cpu |
object |
A CPU de cada nó de réplica no cluster. Unidade: núcleos. |
|
| UsedCpu |
number |
A CPU utilizada do cluster. Unidade: núcleos. |
8 |
| TotalCpu |
number |
O número total de núcleos de CPU do tenant. Unidade: Núcleo. |
10 |
| UnitCpu |
number |
O número de núcleos de CPU por unidade do tenant. Unidade: Núcleo. |
8 |
| Memory |
object |
As informações de memória do cluster. |
|
| UsedMemory |
number |
A memória usada pelo tenant. Unidade: GB. |
30 |
| TotalMemory |
number |
O tamanho total de memória do tenant. Unidade: GB. |
64 |
| UnitMemory |
number |
O tamanho de memória de cada unidade do tenant. Unidade: GB. |
32 |
| DiskSize |
object |
A especificação de tamanho do disco de dados. |
|
| UsedDiskSize |
number |
O tamanho de disco usado pelo tenant. Unidade: GB. |
86 |
| CapacityUnit |
object |
As informações da unidade de capacidade. |
|
| MaxCapacityUnit |
integer |
A unidade de capacidade máxima. |
16 |
| MinCapacityUnit |
integer |
A unidade de capacidade mínima. |
1 |
| UsedCapacit |
integer |
A unidade de capacidade usada. |
5 |
| LogDiskSize |
object |
As informações de tamanho do disco de log. |
|
| TotalLogDisk |
integer |
O tamanho total do disco de log. Unidade: GB. |
8.0 |
| UnitLogDisk |
integer |
A unidade do disco de log. |
8.0 |
| EnableReadOnlyReplica |
boolean |
Indica se réplicas somente leitura são suportadas. |
true |
| RecycleBinStatus |
string |
O status da lixeira do tenant. ON indica ativado e OFF indica desativado. |
ON |
| LowerCaseTableNames |
integer |
Indica se os nomes das tabelas diferenciam maiúsculas de minúsculas. Valores válidos: |
1 |
| Version |
string |
As informações da versão. |
4.2.1 |
| OdpVersion |
string |
A versão do ODP. |
4.3.1-xxxxxxxxx |
| TenantMaxConnections |
integer |
O número máximo de conexões permitidas para o tenant. |
1600 |
| ParameterTemplate |
string |
O modelo de parâmetros. |
express_oltp |
| Iops |
integer |
O IOPS do tenant. |
10000 |
Exemplos
Resposta de sucesso
JSON formato
{
"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
}
}Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.