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.

Nesta página

Mostrar todos

Central de ajuda/ Distributed Cache Service/ Referência de API/ As API desatualizadas (Indisponível em breve)/ As API de gerenciamento de parâmetro/ Consulta de parâmetros de configuração da instância DCS

Consulta de parâmetros de configuração da instância DCS

Atualizado em 2022-11-09 GMT+08:00

Ver PDF

Função

Essa API é usada para consultar os parâmetros de configuração de uma instância de DCS.

URI

GET /v1.0/{project_id}/instances/{instance_id}/configs

Tabela 1 descreve os parâmetros.

**Tabela 1** Descrição do parâmetro
Parâmetro	Tipo	Obrigatório	Descrição
project_id	String	Sim	ID do projeto.
instance_id	String	Sim	ID da instância a ser consultada.

Solicitação

Parâmetros de solicitação

Nenhum.

Exemplo de solicitações

GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs

Resposta

Parâmetros de resposta

Tabela 2 descreve os parâmetros de resposta.

**Tabela 2** Descrição do parâmetro
Parâmetro	Tipo	Descrição
status	String	Status atual de uma instância de DCS.
instance_id	String	ID da instância do DCS.
redis_config	Array	Matriz de itens de configuração da instância do DCS. Para mais detalhes, consulte Tabela 3.
config_status	String	Status da instância de DCS que está sendo modificada ou foi modificada. Opções: UPDATING FAILURE SUCCESS
config_time	String	Hora em que a instância do DCS é operada. Por exemplo, 2017-03-31T12:24:46.297Z.

**Tabela 3** descrição do parâmetro redis_config
Parâmetro	Tipo	Descrição
description	String	Descrição do item de configuração.
param_id	Integer	ID do parâmetro de configuração. Para obter os valores possíveis, consulte a coluna Parameter ID em Tabela 4.
param_name	String	Nome do parâmetro de configuração. Para obter os valores possíveis, consulte a coluna Parameter Name em Tabela 4.
param_value	String	Valor do parâmetro de configuração.
default_value	String	Valor padrão do parâmetro de configuração. Para obter os valores possíveis, consulte a coluna Default Value em Tabela 4.
value_type	String	Tipo do valor do parâmetro de configuração. Para obter os valores possíveis, consulte a coluna Value Type em Tabela 4.
value_range	String	Intervalo do valor do parâmetro de configuração. Para obter os valores possíveis, consulte a coluna Value Range em Tabela 4.

Tabela 4 descreve os parâmetros de configuração de uma instância de DCS.

**Tabela 4** Parâmetros de configuração de uma instância de DCS
ID do parâmetro	Nome do Parâmetro	Motor aplicável	Tipo do valor	Descrição	Intervalo de valores	Valor padrão
1	timeout	Redis e Memcached	Interger	A conexão entre o cliente e o servidor (instância DCS) será fechada se o cliente estiver ocioso durante o período de tempo limite (medido em segundos). Um período de tempo limite de 0 segundos indica que a função de tempo limite está desativada.	0 a 7200. Unidade: segundo.	0
2	maxmemory-policy	Redis e Memcached	Enum	Como o Redis selecionará o que remover quando a memória máxima for alcançada. Para obter mais informações sobre esse parâmetro, consulte https://redis.io/topics/lru-cache.	volatile-lru allkeys-lru volatile-random allkeys-random volatile-ttl noeviction	noeviction
3	hash-max-ziplist-entries	Redis	Interger	Quando o número de entradas em hashes é menor que o valor deste parâmetro, os hashes são codificados usando ziplist para economizar memória.	1–10.000	512
4	hash-max-ziplist-value	Redis	Interger	Quando a maior entrada em hashes não excede o limite de comprimento indicado por este parâmetro, os hashes são codificados usando ziplist para economizar memória.	1–10.000	64
5	list-max-ziplist-entries	Redis	Interger	Quando o número de entradas nas listas é menor que o valor deste parâmetro, as listas são codificadas usando ziplist para economizar memória.	1–10.000	512
6	list-max-ziplist-value	Redis	Interger	Quando a maior entrada em listas não exceder o limite de comprimento indicado por este parâmetro, as listas são codificadas usando ziplist para economizar memória.	1–10.000	64
7	set-max-intset-entries	Redis	Interger	Quando um conjunto é composto inteiramente de strings e o número de inteiros não excede o limite de comprimento indicado por este parâmetro, o conjunto é codificado usando intset para economizar memória.	1–10.000	512
8	zset-max-ziplist-entries	Redis	Interger	Quando o número de entradas em conjuntos ordenados é menor que o valor deste parâmetro, os conjuntos ordenados são codificados usando um ziplist para economizar memória.	1–10.000	128
9	zset-max-ziplist-value	Redis	Interger	Quando a maior entrada em conjuntos ordenados não exceder o limite de comprimento indicado por este parâmetro, os conjuntos ordenados são codificados usando ziplist para economizar memória.	1–10.000	64
10	latency-monitor-threshold	Redis	Interger	A quantidade mínima de latência que será registrada como picos de latência Se esse parâmetro for definido como 0, o monitoramento de latência será desativado. Se esse parâmetro for definido como um valor maior que 0, todos os eventos que bloqueiam o servidor por um tempo maior que o valor configurado serão registrados. Ao executar o comando LATENCY, você pode executar operações relacionadas ao monitoramento de latência, como obter dados estatísticos e configurar e ativar o monitoramento de latência. Para obter mais informações sobre o latency-monitor-threshold, visite https://redis.io/docs/reference/optimization/latency-monitor/.	0–86.400.000 ms	0
12	reserved-memory	Redis	Interger	Memória reservada, que está disponível apenas para instâncias de nó único e principal/em espera. Este parâmetro indica o número de megabytes reservados para que o back-end execute o processamento interno, como persistência e replicação principal/em espera. O tamanho da memória reservada pode ser ajustado, mas deve estar no intervalo de valores descrito na próxima coluna. Nota: Para obter mais informações sobre o máximo de memória disponível para cada tipo de instância, consulte Visão geral de serviço de DCS.	0% a 80% do espaço máximo de memória disponível inicialmente para a instância e abaixo do espaço de memória livre atual. Unidade: MB.	0
13	notify-keyspace-events	Redis	String	Notificação de eventos do espaço de chave. Se esse parâmetro estiver configurado, o recurso Redis Sub/Pub permitirá que os clientes recebam um evento quando um conjunto de dados do Redis for modificado.	Se o valor do parâmetro for uma cadeia de caracteres vazia ou null, o valor padrão Ex será usado. Se o valor do parâmetro contiver vários caracteres, a notificação de eventos de keyspace será ativada e cada caractere identificará uma classe de eventos de keyspace para os quais o Redis enviará notificações. K: Eventos de espaço de chave, publicados com o __keyspace@__ prefix E: Eventos keyevent, publicados com o __keyevent@__ prefix g: Comandos genéricos (não específicos do tipo), como DEL, EXPIRE e RENAME $: Comandos de string l: Comandos de lista s: Definir comandos h: Comandos hash z: Comandos do conjunto classificado x: Eventos expirados (eventos gerados toda vez que uma chave expira) e: Eventos despejados (eventos gerados quando uma chave é despejada por maxmemory) Para obter mais informações, consulte a seguinte nota.	Ex

Mais informações sobre o parâmetro notify-keyspace-events:

Caracteres permitidos são K, E, KE, A, g, l, s, h, z, x, e, e $. O valor do parâmetro deve conter K ou E.
A é um alias para g$lshzxe e não pode ser usado junto com nenhum dos caracteres em g$lshzxe.
Por exemplo, o valor Kl significa que o Redis pode notificar clientes Pub/Sub sobre eventos de espaço de chaves e comandos de lista. O valor AKE significa que o Redis notificará os clientes do Pub/Sub sobre todos os eventos.

Exemplo de resposta

{
    "status": "RUNNING",
    "instance_id": "c08fdc6e-5c25-4185-ab57-c0a5529b727f",
    "redis_config": [
        {
            "description": "How Redis will select what to remove when maxmemory is reached, You can select among five behaviors: volatile-lru : remove the key with an expire set using an LRU algorithm allkeys-lru : remove any key according to the LRU algorithm volatile-random: remove a random key with an expire set allkeys-random: remove a random key, any key volatile-ttl : remove the key with the nearest expire time (minor TTL) noeviction : don't expire at all, just return an error on write operations",
            "param_id": 2,
            "param_name": "maxmemory-policy",
            "param_value": "noeviction",
            "default_value": "noeviction",
            "value_type": "Enum",
            "value_range": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction"
        },
        {
            "description": "Hashes are encoded using a memory efficient data structure when they have a small number of entries",
            "param_id": 3,
            "param_name": "hash-max-ziplist-entries",
            "param_value": "512",
            "default_value": "512",
            "value_type": "Interger",
            "value_range": "1-10000"
        },
        {
            "description": "Hashes are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold",
            "param_id": 4,
            "param_name": "hash-max-ziplist-value",
            "param_value": "64",
            "default_value": "64",
            "value_type": "Interger",
            "value_range": "1-10000"
        },
        {
            "description": "Lists are encoded using a memory efficient data structure when they have a small number of entries",
            "param_id": 5,
            "param_name": "list-max-ziplist-entries",
            "param_value": "512",
            "default_value": "512",
            "value_type": "Interger",
            "value_range": "1-10000"
        },
        {
            "description": "Lists are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold",
            "param_id": 6,
            "param_name": "list-max-ziplist-value",
            "param_value": "64",
            "default_value": "64",
            "value_type": "Interger",
            "value_range": "1-10000"
        },
        {
            "description": "When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers.",
            "param_id": 7,
            "param_name": "set-max-intset-entries",
            "param_value": "512",
            "default_value": "512",
            "value_type": "Interger",
            "value_range": "1-10000"
        },
        {
            "description": "Sorted sets are encoded using a memory efficient data structure when they have a small number of entries",
            "param_id": 8,
            "param_name": "zset-max-ziplist-entries",
            "param_value": "128",
            "default_value": "128",
            "value_type": "Interger",
            "value_range": "1-10000"
        },
        {
            "description": "Sorted sets are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold",
            "param_id": 9,
            "param_name": "zset-max-ziplist-value",
            "param_value": "64",
            "default_value": "64",
            "value_type": "Interger",
            "value_range": "1-10000"
        },
        {
            "description": "Close the connection after a client is idle for N seconds (0 to disable)",
            "param_id": 1,
            "param_name": "timeout",
            "param_value": "0",
            "default_value": "0",
            "value_type": "Interger",
            "value_range": "0-7200"
        },
        {
            "description": "Only events that run in more time than the configured latency-monitor-threshold will be logged as latency spikes. If latency-monitor-threshold is set to 0, latency monitoring is disabled. If latency-monitor-threshold is set to a value greater than 0, all events blocking the server for a time equal to or greater than the configured latency-monitor-threshold will be logged.",
            "param_id": 10,
            "param_name": "latency-monitor-threshold",
            "param_value": "0",
            "default_value": "0",
            "value_type": "Interger",
            "value_range": "0-86400000"
        },
        {
            "description": "The total memory, in bytes, reserved for non-data usage.",
            "param_id": 12,
            "param_name": "reserved-memory",
            "param_value": "0",
            "default_value": "0",
            "value_type": "Interger",
            "value_range": "0-6553"
        },
        {
            "description": "Redis can notify Pub or Sub clients about events happening in the key space",
            "param_id": 13,
            "param_name": "notify-keyspace-events",
            "param_value": null,
            "default_value": null,
            "value_type": "regular",
            "value_range": "([KE]+([A]|[g$lshzxe]+)){0,11}"
        }
    ],
    "config_status": "SUCCESS",
    "config_time": ""
}

Código de status

Tabela 5 descreve o código de status das operações bem-sucedidas. Para obter detalhes sobre outros códigos de status, consulte Tabela 1.

**Tabela 5** Código de status
Código de status	Descrição
200	Configurações de instância consultadas com êxito.

Tópico principal: As API de gerenciamento de parâmetro

Tópico anterior: Modificação dos parâmetros de configuração da instância DCS

Próximo tópico: As API de backup e restauração

Feedback

Esta página foi útil?

Sim Não

Deixar um comentário

Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.

O sistema está ocupado. Tente novamente mais tarde.

Quais dos seguintes problemas você encontrou?

O conteúdo é inconsistente com a UI do produto

Descrições pouco claras

Falta de exemplos ou código

Passos incorretos

Não encontro o que preciso

Falta de melhores práticas

Feedback (opcional)

0/500

Selecione pelo menos um tipo de problema e insira seus comentários ou sugestões.

Insira um máximo de 500 caracteres.

Enviar Cancelar