Todos os produtos
Search

Este produto

    ApsaraDB for OceanBase (Deprecated):DescribeTenant

    Central de documentação

    ApsaraDB for OceanBase (Deprecated):DescribeTenant

    Última atualização: Jun 29, 2026

    Visualiza informações sobre um tenant especificado em um cluster especificado.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    oceanbase:DescribeTenant

    get

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    InstanceId

    string

    Sim

    ID do cluster OceanBase.

    ob317v4uif****
    TenantId

    string

    Sim

    ID do tenant.

    t4pnum****

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Informações detalhadas do tenant.

    RequestId

    string

    ID da solicitação.

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

    object

    Informações do tenant.

    TenantId

    string

    ID do tenant.

    t4louaeei****
    TenantName

    string

    Nome do tenant.

    forMySQLTenant
    TenantMode

    string

    Modo do tenant.
    Valores suportados:

    • Oracle: modo Oracle.

    • MySQL: modo MySQL.

    MySQL
    VpcId

    string

    ID da VPC. Se você não tiver uma VPC adequada, crie uma conforme as instruções no console. Para mais informações, consulte O que é uma nuvem privada virtual?

    vpc-bp1d2q3mhg9i23ofi****
    Status

    string

    Status do tenant:

    • ONLINE: em execução.

    • PENDING_CREATE: criando.

    • WAITING_ALLOCATE_MASTER_ADDRESS: (banco de dados secundário) aguardando criação do endpoint primário.

    • ALLOCATING_MASTER_ADDRESS: criando endpoint primário.

    • DELETING_MASTER_ADDRESS: excluindo endpoint primário.

    • ALLOCATING_INTERNET_ADDRESS: criando endpoint público.

    • PENDING_OFFLINE_INTERNET_ADDRESS: excluindo endpoint público.

    • ALLOCATING_READONLY_ADDRESS: criando endpoint somente leitura.

    • DELETING_READONLY_ADDRESS: excluindo endpoint somente leitura.

    • ALLOCATING_READWRITE_ADDRESS: criando endpoint de divisão de leitura/gravação.

    • DELETING_READWRITE_ADDRESS: excluindo endpoint de divisão de leitura/gravação.

    • ALLOCATING_CLOGSERVICE_ADDRESS: criando endpoint de log de transações.

    • DELETING_CLOGSERVICE_ADDRESS: excluindo endpoint de log de transações.

    • MODIFYING_ADDRESS: modificando nome de domínio do endpoint.

    • MODIFYING_PRIMARY_ZONE: alternando zona primária.

    • MODIFYING_READONLY_ADDRESS: modificando endpoint somente leitura.

    • MODIFYING_READWRITE_ADDRESS: modificando endpoint de divisão de leitura/gravação.

    • SPEC_MODIFYING: modificando especificações.

    • WHITE_LIST_MODIFYING: modificando lista de permissões.

    • CREATING_BINLOG: criando Binlog.

    ONLINE
    EnableInternetAddressService

    boolean

    Indica se o endpoint público do tenant pode ser ativado.

    true
    PrimaryZone

    string

    Zona primária do tenant.

    cn-hangzhou-h
    DeployType

    string

    Tipo de implantação do cluster.

    • multiple: múltiplos data centers.

    • single: único data center.

    • dual: dois data centers.

    multiple
    DeployMode

    string

    Modo de réplica de dados do tenant.

    • Para a Edição de Alta Disponibilidade: N-N-N para três regiões; N-N para duas zonas e zona única.

    • Para a Edição Básica: N.

    Nota


    N é 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

    Descrição do tenant.

    paycore database
    CreateTime

    string

    Hora de criação do tenant.

    2023-04-21 11:15:47.0
    TenantResource

    object

    Informações de recursos do tenant.

    UnitNum

    integer

    Number of tenant units.

    1
    Cpu

    object

    CPU resource information of the tenant.

    UsedCpu

    number

    Used CPU cores of the tenant. Unit: Core.

    8
    TotalCpu

    number

    Total CPU cores of the tenant. Unit: Core.

    10
    UnitCpu

    number

    CPU cores per unit of the tenant. Unit: Core.

    8
    Memory

    object

    Memory resource information of the tenant.

    UsedMemory

    number

    Used memory of the tenant. Unit: GB.

    30
    TotalMemory

    number

    Total memory size of the tenant. Unit: GB.

    64
    UnitMemory

    number

    Memory size per unit of the tenant. Unit: GB.

    32
    DiskSize

    object

    Disk resource information of the tenant.

    UsedDiskSize

    number

    Used disk size of the tenant. Unit: GB.

    86
    CapacityUnit

    object

    Capacity unit.

    MaxCapacityUnit

    integer

    Maximum capacity unit.

    16
    MinCapacityUnit

    integer

    Minimum capacity unit.

    1
    UsedCapacit

    integer

    Used capacity unit.

    5
    LogDiskSize

    object

    Log disk resource information of the tenant.

    TotalLogDisk

    integer

    Total allocated log disk size of the tenant. Unit: GB.

    8.0
    UnitLogDisk

    integer

    Allocated log disk size per unit of the tenant. Unit: GB.

    8.0
    TenantConnections

    array<object>

    Informações de conexão do tenant.

    object

    Informações de conexão do tenant.

    IntranetAddress

    string

    Private endpoint for accessing the tenant.

    t4nunwxr0****.oceanbase.aliyuncs.com
    IntranetPort

    integer

    Private port for accessing the tenant.

    2983
    InternetAddress

    string

    Public endpoint for accessing the tenant.

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

    integer

    Public port for accessing the tenant.

    3306
    VpcId

    string

    VPC ID.

    vpc-bp1qiail1asmfe23t****
    VSwitchId

    string

    VSwitch ID.

    vsw-bp1i7b94u2et716yl****
    IntranetAddressMasterZoneId

    string

    Primary zone corresponding to the tenant's connection endpoint.

    cn-hangzhou-b
    IntranetAddressSlaveZoneId

    string

    Secondary zone corresponding to the tenant's connection endpoint.

    cn-hangzhou-g
    IntranetAddressStatus

    string

    Status of the tenant's private endpoint. ONLINE: in service.

    ONLINE
    ConnectionZones

    array

    List of zones accessible through the tenant connection.

    ["cn-hangzhou-i", "cn-hangzhou-j"]

    string

    Zone accessible through the tenant connection.

    cn-hangzhou-b
    InternetAddressStatus

    string

    Status of the tenant's public network connection.

    • CLOSED: shutdown.

    • ALLOCATING_INTERNET_ADDRESS: requesting.

    • PENDING_OFFLINE_INTERNET_ADDRESS: shutting down public endpoint.

    • ONLINE: in service.

    CLOSED
    TransactionSplit

    boolean

    Indicates whether transaction splitting is enabled.

    false
    AddressType

    string

    Endpoint type.

    • MASTER: primary endpoint, supports read and write.

    • READONLY: read-only endpoint, supports read only.

    • READWRITE: read/write splitting endpoint, enables automatic read/write splitting.

    • CLOGSERVICE: transaction log service endpoint.

    Valores válidos:

    • MASTER :

      MASTER

    • READWRITE :

      READWRITE

    • CLOGSERVICE :

      CLOGSERVICE

    • READONLY :

      READONLY

    READONLY
    EnableTransactionSplit

    boolean

    Indicates whether transaction splitting is enabled.

    false
    ParallelQueryDegree

    integer

    Degree of parallelism.

    1
    TenantEndpointId

    string

    Tenant endpoint ID.

    obe-4tw51gp7****
    MaxConnectionNum

    integer

    Maximum connections.

    5000
    ConnectionReplicaType

    string

    Replica type corresponding to the connection.

    FULL
    ProxyClusterId

    string

    ODP cluster ID.

    proxy-xxxxxxx
    MaxConnectionLimit

    integer

    Current value of maximum private connections.

    1000
    InternetMaxConnectionLimit

    integer

    Upper limit of maximum public connections.

    4000
    IntranetRpcPort

    integer

    Private bypass import port.

    3307

    InternetMaxConnectionNum

    integer

    Current value of maximum public connections.

    2500
    InternetRpcPort

    integer

    Public bypass import port.

    3307
    ConnectionLogicalZones

    array

    Logical zones where the endpoint resides.

    string

    Information about the logical zone where the endpoint resides.

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

    integer

    Private SQL port.

    3306
    OdpVersion

    string

    ODP version.

    4.3.1-xxxxxxxxx
    InternetSqlPort

    integer

    Public SQL port.

    InternetAddressServiceType

    string

    Type of public endpoint.

    IntranetAddressServiceType

    string

    Type of private endpoint.

    TenantZones

    array<object>

    Informações de zona do tenant.

    array<object>

    Informações de zona do tenant.

    TenantZoneId

    string

    Tenant zone ID.

    cn-hangzhou-h
    Region

    string

    Region to which the tenant zone belongs.

    cn-hangzhou
    TenantZoneRole

    string

    Role of the tenant zone.

    ReadWrite
    TenantZoneReplicas

    array<object>

    Replica information of the tenant zone.

    object

    Replica information of the tenant zone.

    ZoneReplicaType

    string

    Replica type of the zone.

    FULL
    ZoneNodes

    integer

    Zone nodes.

    1
    LogicZoneName

    string

    Logical zone name.

    cn-shanghai-f-z0
    ZoneCopyId

    integer

    Zone replica ID.

    2
    FullCopyId

    integer

    Full-function replica ID.

    3
    ReadOnlyCopyId

    string

    Read-only replica ID.

    3
    ReadOnlyReplicaType

    string

    Read-only replica type.

    ROW_STORE
    ClogServiceStatus

    string

    Status do serviço Clog.

    • CLOSED: desativado.

    • ONLINE: em serviço.

    ONLINE
    EnableClogService

    boolean

    Indica se o serviço Clog está disponível. Para ativá-lo, envie um ticket.

    true
    Charset

    string

    Conjunto de caracteres.

    gb18030
    Collation

    string

    Ordenação.

    gb18030_chinese_ci
    PrimaryZoneDeployType

    string

    Modo de implantação da zona primária do tenant.

    Valores válidos:

    • RANDOM :

      RANDOM.

    • STATIC :

      STATIC.

    STATIC
    MasterIntranetAddressZone

    string

    Zona onde o nó Master reside.

    cn-hangzhou-h
    PayType

    string

    Tipo de pagamento.

    POSTPAY
    InstanceType

    string

    Tipo de instância.

    KAFKA_PUBLIC
    Series

    string

    Edição da instância.

    normal
    DiskType

    string

    Tipo de disco.

    cloud_essd_pl1
    AvailableZones

    array

    Lista de zonas de disponibilidade.

    string

    Lista de zonas de disponibilidade.

    ["cn-hangzhou-i"]
    EnableReadWriteSplit

    boolean

    Indica se o endpoint de divisão de leitura/gravação pode ser ativado.

    true
    EnableParallelQuery

    boolean

    Indica se a consulta paralela pode ser ativada.

    true
    MaxParallelQueryDegree

    integer

    Limite superior do grau de paralelismo.

    32
    EnableBinlogService

    boolean

    Indica se o serviço Binlog pode ser solicitado.

    true
    TimeZone

    string

    Fuso horário.

    Asia/Shanghai
    DataMergeTime

    string

    Hora de merge do tenant. Suportado apenas no OceanBase V4.0.0 e versões posteriores.

    02:36Z
    ReadOnlyResource

    object

    Informações de recursos somente leitura.

    UnitNum

    integer

    Number of tenant units.

    2
    Cpu

    object

    CPU per replica node in the cluster. Unit: Core.

    UsedCpu

    number

    Used CPU of the cluster. Unit: Core.

    8
    TotalCpu

    number

    Total CPU cores of the tenant. Unit: Core.

    10
    UnitCpu

    number

    CPU cores per unit of the tenant. Unit: Core.

    8
    Memory

    object

    Cluster memory information.

    UsedMemory

    number

    Used memory of the tenant. Unit: GB.

    30
    TotalMemory

    number

    Total memory size of the tenant. Unit: GB.

    64
    UnitMemory

    number

    Memory size per unit of the tenant. Unit: GB.

    32
    DiskSize

    object

    Data disk size specification.

    UsedDiskSize

    number

    Used disk size of the tenant. Unit: GB.

    86
    CapacityUnit

    object

    Capacity unit information.

    MaxCapacityUnit

    integer

    Maximum capacity unit.

    16
    MinCapacityUnit

    integer

    Minimum capacity unit.

    1
    UsedCapacit

    integer

    Used capacity unit.

    5
    LogDiskSize

    object

    Log disk size information.

    TotalLogDisk

    integer

    Total log disk size. Unit: GB.

    8.0
    UnitLogDisk

    integer

    Log disk unit.

    8.0
    EnableReadOnlyReplica

    boolean

    Indicates whether read-only replicas are supported.

    true
    RecycleBinStatus

    string

    Tenant recycle bin status. ON indicates enabled. OFF indicates disabled.

    ON
    LowerCaseTableNames

    integer

    Indicates whether table names are case-sensitive. Valid values:

    • 1: not case-sensitive

    • 0: case-sensitive

    1
    Version

    string

    Version information.

    4.2.1
    OdpVersion

    string

    Versão do ODP.

    4.3.1-xxxxxxxxx
    TenantMaxConnections

    integer

    Maximum allowed connections for the tenant.

    1600
    ParameterTemplate

    string

    Parameter template.

    express_oltp
    Iops

    integer

    Tenant IOPS.

    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.