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/ Distributed Cache Service/ Referência de API/ API V2/ Gerenciamento de ciclo de vida/ Consulta de uma instância de DCS

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

Ver PDF

Consulta de uma instância de DCS

Função

Essa API é usada para consultar os detalhes sobre uma instância de DCS especificada.

URI

GET /v2/{project_id}/instances/{instance_id}

**Tabela 1** Parâmetros de caminho
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

Nenhum

Parâmetros de resposta

Código de estado: 200

**Tabela 2** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
vpc_name	String	Nome da VPC.
charging_mode	Integer	Modo de cobrança. O valor pode ser 0: pay-per-use.
vpc_id	String	ID de VPC
user_name	String	Nome de usuário.
created_at	String	Hora em que a instância é criada. Formato: 2017-03-31T12:24:46.297Z
description	String	Descrição da instância
security_group_id	String	ID do grupo de segurança.
security_group_name	String	Nome do grupo de segurança.
max_memory	Integer	Tamanho total da memória em MB.
used_memory	Integer	Tamanho de memória usado em MB.
capacity	Integer	Capacidade do cache da instância DCS em GB.
capacity_minor	String	Capacidade (GB) de uma pequena instância de DCS (menor que 1 GB).
maintain_begin	String	Hora UTC quando a janela de tempo de manutenção é iniciada. O formato é HH:mm:ss.
maintain_end	String	Hora UTC quando a janela de tempo de manutenção termina. O formato é HH:mm:ss.
engine	String	Mecanismo de instância DCS.
no_password_access	String	Indica se a instância pode ser acessada sem uma senha. true: A instância pode ser acessada sem uma senha. false: A instância pode ser acessada somente após a autenticação de senha.
ip	String	Endereço IP para conexão com a instância do DCS. Para uma instância de cluster, vários endereços IP são retornados e separados por vírgulas (,). Por exemplo, 192.168.0.1,192.168.0.2.
instance_backup_policy	InstanceBackupPolicy object	Política de backup. Este parâmetro é suportado quando o tipo de instância é principal/em espera ou cluster.
az_codes	Array of strings	AZ em que a instância está. O código AZ é retornado.
access_user	String	Nome de usuário usado para acessar uma instância de DCS após a autenticação de senha.
instance_id	String	ID da instância.
port	Integer	Porta da instância do DCS.
user_id	String	ID do usuário.
name	String	Nome da instância.
spec_code	String	Código de especificação.
subnet_id	String	ID da sub-rede.
subnet_name	String	Nome da sub-rede.
subnet_cidr	String	Bloco CIDR da sub-rede.
engine_version	String	Versão cache.
order_id	String	ID do pedido.
status	String	Status da instância do DCS. Para obter detalhes, consulte Status da instância do DCS.
domain_name	String	Nome de domínio da instância.
readonly_domain_name	String	Nome de domínio somente leitura da instância. Esse parâmetro está disponível somente para instâncias principal/em espera.
enable_publicip	Boolean	Indica se o acesso à rede pública está habilitado para a instância do DCS Redis. true: ativar false: desativar
publicip_id	String	ID do EIP vinculado à instância do DCS Redis. O valor deste parâmetro é null se o acesso público estiver desabilitado.
publicip_address	String	EIP vinculado à instância do DCS Redis. O valor deste parâmetro é null se o acesso público estiver desabilitado.
enable_ssl	Boolean	Se o SSL está ativado para acesso público a uma instância do DCS Redis. true: ativar false: desativar
service_upgrade	Boolean	Se a instância tem uma tarefa de upgrade. true: sim false: não
service_task_id	String	Atualizar ID da tarefa. Se o valor de service_upgrade for definido como true, o valor desse parâmetro será o ID da tarefa de atualização. Se o valor de service_upgrade for definido como false, o valor desse parâmetro ficará vazio.
enterprise_project_id	String	ID do projeto empresarial.
backend_addrs	String	Endereço de backend de uma instância de cluster.
features	Features object	Funcionalidades suportadas pela instância.
domain_name_info	DomainNameInfo object	Informações sobre atualização de nome de domínio de instância e resolução de nome de domínio público.
transparent_client_ip_enable	Boolean	Se a passagem de IP do cliente está habilitada.
sub_status	String	Sub-status da instância.
tags	Array of ResourceTag objects	Chave e valor da tag de instância.
cpu_type	String	Tipo de CPU da instância. Geralmente, o valor é x86_64 ou aarch64.
enterprise_project_name	String	Nome do projeto corporativo.
update_at	String	Tempo de atualização, por exemplo, 2022-07-06T09:32:16.502Z.
product_type	String	Edição: Community Edition ou Professional Edition. Valores de enumeração: generic enterprise
storage_type	String	Tipo de armazenamento (DRAM). Valores de enumeração: DRAM
launched_at	String	Hora de início, por exemplo, 2022-07-06T09:32:16.502Z.
cache_mode	String	Tipos de instância do DCS. Opções: single: nó único ha: principal/em espera cluster: Cluster do Redis proxy: Cluster de proxy
support_slow_log_flag	String	Se os logs de consulta lenta são suportados.
db_number	Integer	Número de bases de dados.
replica_count	Integer	Número de réplicas.
sharding_count	Integer	Número de partições em uma instância de cluster.
bandwidth_info	BandwidthInfo object	Informações de largura de banda.

**Tabela 3** InstanceBackupPolicy
Parâmetro	Tipo	Descrição
backup_policy_id	String	ID da política de backup.
created_at	String	Tempo de criação. Exemplo: 2022-04-11T09:45:24.790Z
updated_at	String	Hora da atualização. Exemplo: 2022-04-12T02:22:03.269Z
policy	BackupPolicy object	Política de backup.
tenant_id	String	ID da conta.

**Tabela 4** BackupPolicy
Parâmetro	Tipo	Descrição
backup_type	String	Tipo de backup. auto: backup automático manual: backup manual
save_days	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	BackupPlan object	Agendamento de backup. Este parâmetro é obrigatório quando backup_type é definido como manual.

**Tabela 5** BackupPlan
Parâmetro	Tipo	Descrição
timezone_offset	String	Fuso horário em que o backup é realizado. Este parâmetro não é mais usado.
backup_at	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	String	Intervalo em que o backup é executado, que suporta apenas weekly atualmente.
begin_at	String	Hora UTC quando o backup é iniciado. Por exemplo, 00:00-01:00 indica que o backup começa às 08:00 (GMT+8).

**Tabela 6** Funcionalidades
Parâmetro	Tipo	Descrição
support_acl	Boolean	Se a ACL é apoiada. true: sim false: não
support_transparent_client_ip	Boolean	Se a passagem de IP do cliente está habilitada. true: sim false: não
support_ssl	Boolean	Se o SSL é suportado. true: sim false: não

**Tabela 7** DomainNameInfo
Parâmetro	Tipo	Descrição
support_public_resolve	Boolean	Se ativar a resolução de nomes de domínio público. true: ativar false: desativar
is_latest_rules	Boolean	Se o nome de domínio atual é o mais recente. true: sim false: não
zone_name	String	Sufixo de região do nome de domínio.
history_domain_names	Array of DomainNameEntity objects	Informações históricas do nome de domínio.

**Tabela 8** DomainNameEntity
Parâmetro	Tipo	Descrição
domain_name	String	Nomes de domínio históricos da instância.
is_readonly	Boolean	Se o nome de domínio é somente leitura. true: sim false: não

**Tabela 9** ResourceTag
Parâmetro	Tipo	Descrição
key	String	Chave da tag. Este campo não pode ser deixado em branco. O valor-chave de um recurso deve ser exclusivo. A chave de tag pode conter no máximo 36 caracteres. A chave da tag deve ser única e não pode estar vazia.
value	String	Valor da tag. Este parâmetro é obrigatório quando a action é definida para create e é opcional quando a action é definida para delete. O valor da tag pode conter no máximo 43 caracteres.

**Tabela 10** BandwidthInfo
Parâmetro	Tipo	Descrição
begin_time	String	Hora de início do aumento temporário.
end_time	String	Fim do tempo de aumento temporário.
current_time	String	Horário atual.
bandwidth	Integer	Largura de banda atual, em GB.
next_expand_time	String	Próxima aumentar o tempo.
expand_count	Integer	Número de aumentos.
expand_effect_time	String	Intervalo entre aumentos temporários.
expand_interval_time	String	Tempo para o próximo aumento.
max_expand_count	Integer	Número máximo de aumentos.
task_running	Boolean	Se a tarefa está em execução.

Exemplos de solicitações

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}

Exemplo de respostas

Código de estado: 200

A instância especificada é consultada com êxito.

{
  "publicip_id" : null,
  "vpc_name" : "dcs-beta",
  "charging_mode" : 0,
  "enterprise_project_name" : "default",
  "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481",
  "user_name" : "hwclouduser",
  "created_at" : "2022-08-29T08:53:47.319Z",
  "description" : null,
  "security_group_id" : "securityGroupId",
  "enable_ssl" : false,
  "max_memory" : 128,
  "publicip_address" : null,
  "capacity" : 0,
  "maintain_begin" : "18:00:00",
  "engine" : "Redis",
  "maintain_end" : "19:00:00",
  "capacity_minor" : ".125",
  "service_upgrade" : false,
  "subnet_name" : "dcs-beta",
  "no_password_access" : "true",
  "service_task_id" : null,
  "ip" : "192.168.0.251",
  "subnet_cidr" : "192.168.0.0/24",
  "used_memory" : 2,
  "security_group_name" : "securityGroupId",
  "instance_backup_policy" : null,
  "az_codes" : [ "cn-north-7c" ],
  "access_user" : null,
  "enterprise_project_id" : "0",
  "instance_id" : "a4c545cd-10b2-4efc-b0ab-a9b554ca0621",
  "enable_publicip" : false,
  "port" : 6379,
  "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
  "domain_name" : "redis-a4c545cd-10b2-4efc-b0ab-a9b554ca0621.dcs.huaweicloud.com",
  "name" : "dcs-billing",
  "spec_code" : "redis.ha.xu1.tiny.r2.128",
  "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af",
  "engine_version" : "5.0",
  "order_id" : null,
  "status" : "RUNNING",
  "features" : {
    "support_acl" : true,
    "support_transparent_client_ip" : true,
    "support_ssl" : false
  },
  "domain_name_info" : {
    "support_public_resolve" : true,
    "is_latest_rules" : true,
    "zone_name" : "dcs.huaweicloud.com",
    "history_domain_names" : null
  },
  "transparent_client_ip_enable" : true,
  "sub_status" : "normal",
  "tags" : null,
  "cpu_type" : "x86_64"
}