Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Distributed Cache Service/ Referencia de la API/ API V2/ Gestión del ciclo de vida/ Consulta de una instancia de DCS

Actualización más reciente 2022-11-09 GMT+08:00

Ver PDF

Consulta de una instancia de DCS

Función

Esta API se utiliza para consultar los detalles sobre una instancia DCS especificada.

URI

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

**Tabla 1** Parámetros de path
Parámetro	Obligatorio	Tipo	Descripción
instance_id	Sí	String	ID de instancia.
project_id	Sí	String	ID del proyecto.

Parámetros de solicitud

Ninguno

Parámetros de respuesta

Código de estado: 200

**Tabla 2** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
vpc_name	String	Nombre de la VPC.
charging_mode	Integer	Modo de facturación. El valor puede ser 0: pago por uso.
vpc_id	String	ID de la VPC
user_name	String	Nombre de usuario.
created_at	String	Hora en la que se crea la instancia. Formato: 2017-03-31T12:24:46.297Z
description	String	Descripción de la instancia
security_group_id	String	ID del grupo de seguridad.
security_group_name	String	Nombre del grupo de seguridad.
max_memory	Integer	Tamaño total de la memoria en MB.
used_memory	Integer	Tamaño de memoria usado en MB.
capacity	Integer	Capacidad de caché de instancia de DCS en GB.
capacity_minor	String	Capacidad (GB) de una instancia DCS pequeña (menor a 1 GB).
maintain_begin	String	Hora UTC cuando comienza la ventana de tiempo de mantenimiento. El formato es HH:mm:ss.
maintain_end	String	Hora UTC cuando finaliza la ventana de tiempo de mantenimiento. El formato es HH:mm:ss.
engine	String	Motor de instancia DCS.
no_password_access	String	Indica si se puede acceder a la instancia sin contraseña. true: Se puede acceder a la instancia sin una contraseña. false: se puede acceder a la instancia solo después de la autenticación de contraseña.
ip	String	Dirección IP para conectarse a la instancia de DCS. Para una instancia de clúster, se devuelven varias direcciones IP y se separan por comas (,). Por ejemplo, 192.168.0.1,192.168.0.2.
instance_backup_policy	InstanceBackupPolicy object	Política de copia de respaldo. Este parámetro se admite cuando el tipo de instancia es maestro/en espera o clúster.
az_codes	Array of strings	zona de disponibilidad donde se encuentra la instancia. Se devuelve el código zona de disponibilidad.
access_user	String	Nombre de usuario utilizado para acceder a una instancia de DCS después de la autenticación de contraseña.
instance_id	String	ID de instancia.
port	Integer	Puerto de la instancia DCS.
user_id	String	ID de usuario.
name	String	Nombre de instancia.
spec_code	String	Código de especificación.
subnet_id	String	ID de subred.
subnet_name	String	Nombre de subred.
subnet_cidr	String	Bloque CIDR de subred.
engine_version	String	Versión de caché.
order_id	String	ID de pedido.
status	String	Estado de la instancia de DCS. Para obtener más información, consulte Estado de instancia DCS.
domain_name	String	Nombre de dominio de la instancia.
readonly_domain_name	String	Nombre de dominio de sólo lectura de la instancia. Este parámetro sólo está disponible para instancias de tipo principal/en standby.
enable_publicip	Boolean	Indica si el acceso a la red pública está habilitado para la instancia de DCS Redis. true: habilitar false: deshabilitar
publicip_id	String	ID del EIP enlazado a la instancia de DCS Redis. El valor de este parámetro es null si el acceso público está deshabilitado.
publicip_address	String	EIP enlazado a la instancia de DCS Redis. El valor de este parámetro es null si el acceso público está deshabilitado.
enable_ssl	Boolean	Si SSL está habilitado para el acceso público a una instancia de DCS Redis. true: habilitar false: deshabilitar
service_upgrade	Boolean	Si la instancia tiene una tarea de actualización. true: sí. false: no.
service_task_id	String	ID de tarea de actualización. Si el valor de service_upgrade se establece en true, el valor de este parámetro es el ID de la tarea de actualización. Si el valor de service_upgrade se establece en false, el valor de este parámetro está vacío.
enterprise_project_id	String	ID del proyecto de empresa.
backend_addrs	String	Dirección de backend de una instancia de clúster.
features	Features object	Características admitidas por la instancia.
domain_name_info	DomainNameInfo object	Información sobre la actualización de nombre de dominio de instancia y la resolución de nombre de dominio público.
transparent_client_ip_enable	Boolean	Si el paso a través de IP del cliente está habilitado.
sub_status	String	Subestado de instancia.
tags	Array of ResourceTag objects	Clave y valor de la etiqueta de instancia.
cpu_type	String	Tipo de CPU de la instancia. Generalmente, el valor es x86_64 o aarch64.
enterprise_project_name	String	Nombre del proyecto de empresa.
update_at	String	Tiempo de actualización, por ejemplo, 2022-07-06T09:32:16.502Z.
product_type	String	Edición: edición comunitaria o edición profesional. Valores de enumeración: generic enterprise
storage_type	String	Tipo de almacenamiento (DRAM). Valores de enumeración: DRAM
launched_at	String	Hora de inicio, por ejemplo, 2022-07-06T09:32:16.502Z.
cache_mode	String	Tipo de instancia de DCS. Opciones: single: nodo único ha: maestro/en espera cluster: Clúster en Redis proxy: clúster de proxy
support_slow_log_flag	String	Si se admiten registros de consultas lentos.
db_number	Integer	Cantidad de bases de datos.
replica_count	Integer	Número de réplicas.
sharding_count	Integer	Número de shards en una instancia de clúster.
bandwidth_info	BandwidthInfo object	Información de ancho de banda.

**Tabla 3** InstanceBackupPolicy
Parámetro	Tipo	Descripción
backup_policy_id	String	ID de política de copia de respaldo.
created_at	String	Tiempo de creación. Ejemplo: 2022-04-11T09:45:24.790Z
updated_at	String	Tiempo de actualización. Ejemplo: 2022-04-12T02:22:03.269Z
policy	BackupPolicy object	Política de copia de respaldo.
tenant_id	String	ID de cuenta.

**Tabla 4** BackupPolicy
Parámetro	Tipo	Descripción
backup_type	String	Tipo de copia de respaldo. auto: copia de respaldo automática manual: copia de respaldo manual
save_days	Integer	Este parámetro es obligatorio cuando backup_type se establece en manual. Período de retención, en días. Los valores varían de 1 a 7.
periodical_backup_plan	BackupPlan object	Programa de copia de respaldo. Este parámetro es obligatorio cuando backup_type se establece en manual.

**Tabla 5** BackupPlan
Parámetro	Tipo	Descripción
timezone_offset	String	Zona horaria en la que se realiza la copia de respaldo. Este parámetro ya no se utiliza.
backup_at	Array of integers	Día en una semana en el que comienza la copia de respaldo. El valor varía de 1 a 7, donde 1 indica lunes y 7 indica domingo.
period_type	String	Intervalo en el que se realiza la copia de respaldo, que solo admite weekly actualmente.
begin_at	String	Hora UTC cuando se inicia la copia de respaldo. Por ejemplo, 00:00-01:00 indica que la copia de respaldo comienza a las 08:00 (GMT+8).

**Tabla 6** Features
Parámetro	Tipo	Descripción
support_acl	Boolean	Si se admite ACL. true: sí. false: no.
support_transparent_client_ip	Boolean	Si el paso a través de IP del cliente está habilitado. true: sí. false: no.
support_ssl	Boolean	Si se admite SSL. true: sí. false: no.

**Tabla 7** DomainNameInfo
Parámetro	Tipo	Descripción
support_public_resolve	Boolean	Si se debe habilitar la resolución de nombres de dominio público. true: habilitar false: deshabilitar
is_latest_rules	Boolean	Si el nombre de dominio actual es el más reciente. true: sí. false: no.
zone_name	String	Sufijo de región del nombre de dominio.
history_domain_names	Array of DomainNameEntity objects	Información histórica del nombre de dominio.

**Tabla 8** DomainNameEntity
Parámetro	Tipo	Descripción
domain_name	String	Nombres de dominio históricos de la instancia.
is_readonly	Boolean	Si el nombre de dominio es de solo lectura. true: sí. false: no.

**Tabla 9** ResourceTag
Parámetro	Tipo	Descripción
key	String	Clave de etiqueta. Este campo es obligatorio. El valor clave de un recurso debe ser único. La clave de la etiqueta puede incluir, como máximo, 36 caracteres. La clave de etiqueta debe ser única y no puede estar vacía.
value	String	Valor de la etiqueta. Este parámetro es obligatorio cuando action se establece para create y es opcional cuando action se establece para delete. El valor de la etiqueta puede incluir, como máximo, 43 caracteres.

**Tabla 10** BandwidthInfo
Parámetro	Tipo	Descripción
begin_time	String	Hora de inicio del aumento temporal.
end_time	String	Hora de finalización del aumento temporal.
current_time	String	Hora actual.
bandwidth	Integer	Ancho de banda actual, en GB.
next_expand_time	String	Tiempo de próximo aumento
expand_count	Integer	Número de aumentos.
expand_effect_time	String	Intervalo entre aumentos temporales.
expand_interval_time	String	Tiempo para el siguiente aumento.
max_expand_count	Integer	Número máximo de aumentos.
task_running	Boolean	Si la tarea se está ejecutando.

Solicitudes de ejemplo

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

Ejemplo de respuestas

Código de estado: 200

La instancia especificada se consulta correctamente.

{
  "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"
}