Modificação dos detalhes da instância DCS
Função
Essa API é usada para modificar as informações sobre uma instância do DCS, incluindo o nome da instância, a descrição, a porta, a política de backup, o horário de início e término da janela de manutenção e o grupo de segurança.
URI
PUT /v2/{project_id}/instances/{instance_id}
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
instance_id | Sim | String | ID da instância. |
project_id | Sim | String | ID do projeto. |
Parâmetros de solicitação
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
name | Não | String | Nome da instância. Um nome de ocorrência pode conter letras, dígitos, sublinhados (_), e hífens (-) e deve começar com uma letra. Quando você cria apenas uma instância por vez, o valor desse parâmetro pode conter de 4 a 64 caracteres. Quando você cria várias instâncias ao mesmo tempo, o valor desse parâmetro pode conter de 4 a 56 caracteres. As instâncias são nomeadas no formato de custom name-n, em que n começa em 000 e é incrementado em 1. Por exemplo, se você criar duas instâncias e definir o nome personalizado para dcs_demo, as duas instâncias serão denominadas respectivamente dcs_demo-000 e dcs_demo-001. |
description | Não | String | Descrição da instância. A descrição pode conter um máximo de 1024 caracteres. NOTA: A barra invertida (\) e aspas (") são caracteres especiais para mensagens JSON. Ao usar esses caracteres em um valor de parâmetro, adicione o caractere de escape (\) antes dos caracteres, por exemplo, \\ e \”. Mínimo: 0 Máximo: 1024 |
port | Não | Integer | Altere a porta para conexão com a instância do Redis. O intervalo de portas é de 1 a 65535. Depois que a porta é alterada, todas as conexões com a instância do Redis são interrompidas e os serviços devem se conectar à nova porta. Somente as instâncias do DCS Redis 4.0 e 5.0 suportam alteração de porta. Mínimo: 1 Máximo: 65535 |
rename_commands | Não | RenameCommandResp object | Lista de renomeação do comando. |
maintain_begin | Não | String | Hora UTC quando a janela de tempo de manutenção é iniciada. O formato é HH:mm:ss. '
|
maintain_end | Não | String | Hora UTC quando a janela de tempo de manutenção é iniciada. O formato é HH:mm:ss. '
|
security_group_id | Não | String | ID do grupo de segurança. O valor pode ser obtido no console da VPC ou na API. Esse parâmetro é suportado apenas por instâncias do DCS Redis 3.0. |
instance_backup_policy | Não | BackupPolicy object | Política de backup. Este parâmetro é suportado quando o tipo de instância é principal/em espera ou cluster. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
command | Não | String | Comando COMMAND. |
flushall | Não | String | Comando FLUSHALL. |
flushdb | Não | String | Comando FLUSHDB. |
hgetall | Não | String | Comando HGETALL. |
keys | Não | String | Comando KEYS. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
backup_type | Sim | String | Tipo de backup.
|
save_days | Não | Integer | Este parâmetro é obrigatório quando backup_type é definido como manual. Período de retenção, em dias. O valor varia de 1 a 7. |
periodical_backup_plan | Não | BackupPlan object | Agendamento de backup. Este parâmetro é obrigatório quando backup_type é definido como manual. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
timezone_offset | Não | String | Fuso horário em que o backup é realizado. Este parâmetro não é mais usado. |
backup_at | Sim | Array of integers | Dia em uma semana em que o backup começa. O valor varia de 1 a 7, onde 1 indica segunda-feira e 7 indica domingo. |
period_type | Sim | String | Intervalo em que o backup é executado, que suporta apenas weekly atualmente. |
begin_at | Sim | String | Hora UTC quando o backup é iniciado. Por exemplo, 00:00-01:00 indica que o backup começa às 08:00 (GMT+8). |
Parâmetros de resposta
Nenhum
Exemplos de solicitações
PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}
{
"name" : "dcs002",
"description" : "instance description",
"port" : 6379,
"maintain_begin" : "18:00:00",
"maintain_end" : "19:00:00",
"security_group_id" : "18e9309f-f81a-4749-bb21-f74576292162",
"instance_backup_policy" : {
"backup_type" : "auto",
"save_days" : "1,",
"periodical_backup_plan" : {
"backup_at" : [ "1", "2", "3", "4", "6", "7" ],
"period_type" : "weekly",
"begin_at" : "00:00-01:00"
}
}
} Exemplo de respostas
Nenhum
Códigos de status
Código de status | Descrição |
|---|---|
204 | Instância do DCS modificada com sucesso. |
400 | Pedido inválido. |
500 | Erro de serviço interno. |
Códigos de erro
Consulte Códigos de erro.

