Modificação das informações sobre uma instância de DCS
Função
Essa API é usada para modificar as informações sobre uma instância de DCS, incluindo o nome da instância, a descrição, 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.
Solicitação
Parâmetros de solicitação
Parâmetro |
Tipo |
Obrigatório |
Descrição |
---|---|---|---|
name |
String |
Não |
Nome da instância do DCS. Um nome de ocorrência pode conter letras, dígitos, sublinhados (_), e hífens (-) e começa com uma letra. Quando cria apenas uma instância de cada vez, o valor deste parâmetro tem de ser uma cadeia de caracteres que consiste em 4 a 64 caracteres. Quando você cria mais de uma ocorrência por vez, o valor desse parâmetro deve ser uma cadeia de caracteres que consiste de 4 a 56 caracteres. Essas instâncias são nomeadas no formato de "name-n", no qual n começa de 000 e é incrementado de 1. Por exemplo, se você criar duas instâncias e definir name como dcs_demo, as duas instâncias serão nomeadas respectivamente como dcs_demo-000 e dcs_demo-001. |
description |
String |
Não |
Breve descrição da instância do DCS. Uma breve descrição suporta até 1024 caracteres.
NOTA:
"\" é definido como um caractere de escape na descrição da fila. Se precisar inserir um (\) de barra invertida ou um (") de aspas duplas na descrição da fila, insira \\ e \". |
instance_backup_policy |
JSON |
Não |
Política de backup. Esse parâmetro está disponível para instâncias de DCS principal/em espera e de cluster. Para mais detalhes, veja Tabela 4 e Tabela 5. |
maintain_begin |
String |
Não |
Hora em que a janela de tempo de manutenção começa. Formato: hh:mm:ss.
|
maintain_end |
String |
Não |
Hora em que a janela de tempo de manutenção termina. Formato: hh:mm:ss.
|
security_group_id |
String |
Não |
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. |
Exemplo de solicitações
URL da solicitação:
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
- Exemplo 1
{ "description": "instance description" }
- Exemplo 2
{ "name": "dcs002", "description": "instance description", "instance_backup_policy": { "backup_type": "auto", "save_days": 1, "periodical_backup_plan": { "begin_at": "00:00-01:00", "period_type": "weekly", "backup_at": [ "1", "2", "3", "4", "6", "7" ] } }, "security_group_id": "18e9309f-f81a-4749-bb21-f74576292162", "maintain_begin": "02:00:00", "maintain_end": "06:00:00" }
Resposta
Parâmetros de resposta
Nenhum
Exemplo de resposta
Nenhum