Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Document Database Service/ Referência de API/ APIs V3.0 (recomendada)/ Gerenciamento de bancos de dados e usuários/ Consulta de configurações de balanceamento do cluster

Atualizado em 2023-05-06 GMT+08:00

Ver PDF

Consulta de configurações de balanceamento do cluster

Descrição

Essa API é usada para consultar as configurações de balanceamento de dados de um cluster do DDS, incluindo se o balanceamento está habilitado e a janela de tempo das atividades de balanceamento. As informações da janela de tempo de atividade de balanceamento são retornadas somente no DDS 4.0 e versões posteriores.

Restrições

As instâncias congeladas não suportam esta operação.

Depuração

Você pode depurar essa API no API Explorer.

URI

Formato de URI
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balancer
Exemplo de URI
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer

Solicitações

Descrição do parâmetro

**Tabela 1** Parâmetros de solicitação
Nome	Tipo	IN	Obrigatório	Descrição
x-auth-token	string	header	Sim	Token do usuário
project_id	string	path	Sim	ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto.
instance_id	string	path	Sim	ID da instância, que pode ser obtido chamando a API descrita em Consulta de instâncias e detalhes. Se você não tiver uma instância, chame a API descrita em Criação de uma instância de banco de dados para criar uma.

Respostas

Descrição do parâmetro

**Tabela 2** Resposta à solicitação para consultar as configurações de balanceamento de um cluster
Nome	Tipo	Obrigatório	Descrição
is_open	Boolean	Sim	Se o balanceamento de cluster está habilitado.
active_window	Object	Não	A janela de tempo da atividade. Para mais detalhes, consulte Tabela 3.

**Tabela 3** Mensagem de resposta da janela de tempo de atividade
Nome	Tipo	Obrigatório	Descrição
start_time	String	Não	A hora de início da janela de tempo da atividade.
stop_time	String	Não	A hora de término da janela de tempo da atividade.

Exemplo de resposta

{
    "is_open": true,
    "active_window": {
        "start_time":"00:00",
        "stop_time":"02:00"
    }
}

SDK

Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.