Todos os produtos
Search

Este produto

    ApsaraDB for ClickHouse:DescribeAccounts

    Central de documentação

    ApsaraDB for ClickHouse:DescribeAccounts

    Última atualização: Jun 28, 2026

    Descreve as contas de banco de dados de um cluster do ApsaraDB for ClickHouse 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

    clickhouse:DescribeAccounts

    get

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    DBClusterId

    string

    Sim

    O ID do cluster.

    cc-bp108z124a8o7****
    AccountName

    string

    Não

    O nome da conta de banco de dados.

    Nota

    Se este parâmetro não for especificado, a operação consulta informações sobre todas as contas de banco de dados.

    testAccount
    PageSize

    integer

    Não

    O número de entradas a serem retornadas em cada página. Valores válidos:

    • 30 (padrão)

    • 50

    • 100

    30
    PageNumber

    integer

    Não

    O número da página. O valor deve ser um número inteiro maior que 0 e que não exceda o valor máximo do tipo de dados Integer. Valor padrão: 1.

    1

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    TotalCount

    integer

    O número total de entradas retornadas.

    1
    PageSize

    integer

    O número de entradas retornadas por página.

    30
    RequestId

    string

    O ID da solicitação.

    F5178C10-1407-4987-9133-DE4DC9119F75
    PageNumber

    integer

    O número da página.

    1
    Accounts

    object

    Account

    array<object>

    A lista de contas de banco de dados.

    object

    AccountStatus

    string

    The status of the database account. Valid values:

    • Creating: The account is being created.

    • Available: The account is active.

    • AuthorityModifying: The permissions of the account are being modified.

    • Deleting: The account is being deleted.

    Nota

    Only database accounts that are configured using XML files can be in the AuthorityModifying state.

    Creating
    AccountDescription

    string

    The description of the database account.

    test
    AccountType

    string

    The type of the database account. Valid values:

    • Super: a privileged account.

    • Normal: a standard account.

    Super
    AccountName

    string

    The name of the database account.

    test
    ConfigType

    string

    The configuration method of the database account.

    SQL

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": 1,
  "Accounts": {
    "Account": [
      {
        "AccountStatus": "Creating",
        "AccountDescription": "test",
        "AccountType": "Super",
        "AccountName": "test",
        "ConfigType": "SQL"
      }
    ]
  }
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The DBClusterId provided does not exist in our records.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.