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 todas las instancias de DCS

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

Ver PDF

Consulta de todas las instancias de DCS

Función

Esta API se utiliza para consultar instancias de DCS de un inquilino y le permite especificar criterios de consulta.

URI

GET /v2/{project_id}/instances

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

**Tabla 2** Parámetros de Query
Parámetro	Obligatorio	Tipo	Descripción
instance_id	No	String	ID de instancia.
include_failure	No	String	Si se devuelve el número de instancias que no se pueden crear. Si el valor es true, se devuelve el número de instancias que no se han creado. Si el valor no es true, el número no se devuelve.
include_delete	No	String	Si se devuelve el número de instancias que se han eliminado. Si el valor es true, se devuelve el número de instancias que se han eliminado. Si el valor no es true, el número no se devuelve.
name	No	String	Nombre de instancia.
offset	No	Integer	offset, que es la posición en la que comienza la consulta. El valor debe ser mayor o igual a 0.
limit	No	Integer	Número de registros mostrados en cada página. El valor mínimo es 1. El valor máximo es 1000*. Si no se especifica este parámetro, se muestran 10 registros en cada página de forma predeterminada.
status	No	String	Estado de la instancia. Para obtener más información, consulte Estado de instancia DCS.
name_equal	No	String	Si se debe buscar la instancia que coincide exactamente con un nombre de instancia especificado. El valor predeterminado es false, que indica que se realiza una búsqueda difusa basada en un nombre de instancia especificado. Si el valor es true*, se consulta la instancia que coincide exactamente con un nombre de instancia especificado.
tags	No	String	La consulta se basa en la clave y el valor de la etiqueta de instancia. {key} indica la clave de la etiqueta, y {value} indica el valor de la etiqueta. Para consultar instancias con varias claves y valores de etiquetas, separe los pares clave-valor con comas (,).
ip	No	String	Dirección IP para conectarse a la instancia de DCS.
capacity	No	String	Capacidad de caché de instancia de DCS en GB.

Parámetros de solicitud

Ninguno

Parámetros de respuesta

Código de estado: 200

**Tabla 3** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
instance_num	Integer	Número de instancias.
instances	Array of InstanceListInfo objects	Matriz de detalles de instancia.

**Tabla 4** InstanceListInfo
Parámetro	Tipo	Descripción
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.
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 VPC.
subnet_id	String	ID de subred.
security_group_id	String	ID del grupo de seguridad.
created_at	String	Tiempo de creación. Formato: 2017-03-31T12:24:46.297Z
enable_ssl	Boolean	Si SSL está habilitado para el acceso público a una instancia de DCS Redis. true: habilitar false: deshabilitar
max_memory	Integer	Tamaño total de la memoria en MB.
used_memory	Integer	Tamaño de memoria usado en MB.
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.
capacity	Integer	Capacidad de caché (GB)
capacity_minor	String	Capacidad (GB) de una instancia DCS pequeña (menor a 1 GB).
order_id	String	ID de pedido. El valor es nulo cuando se crea una instancia de pago por uso.
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 caché.
engine_version	String	Versión de caché.
service_upgrade	Boolean	Si la instancia tiene una tarea de actualización. true: sí. false: no.
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.
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.
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.
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.
enable_publicip	Boolean	Indica si el acceso a la red pública está habilitado para la instancia de DCS Redis. true: habilitar false: deshabilitar
port	Integer	Puerto de la instancia DCS.
user_id	String	ID de usuario.
user_name	String	Nombre de usuario.
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.
name	String	Nombre de instancia.
spec_code	String	Variante del producto.
status	String	Estado de la instancia. Para obtener más información, consulte Estado de instancia DCS.
tags	Array of ResourceTag objects	Clave y valor de la etiqueta de instancia.
enterprise_project_id	String	ID del proyecto de empresa.
description	String	Descripción de la instancia.
cpu_type	String	Tipo de CPU de la instancia. Generalmente, el valor es x86_64 o aarch64.
az_codes	Array of strings	Zonas de disponibilidad donde hay recursos disponibles.
features	Features object	Características admitidas por la instancia.
sub_status	String	Subestado de instancia.

**Tabla 5** 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 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.

Código de estado: 400

**Tabla 7** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_msg	String	Mensaje de error. Máximo: 1024
error_code	String	Código de error. Máximo: 9
error_ext_msg	String	Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024

Código de estado: 401

**Tabla 8** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_msg	String	Mensaje de error. Máximo: 1024
error_code	String	Código de error. Máximo: 9
error_ext_msg	String	Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024

Código de estado: 403

**Tabla 9** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_msg	String	Mensaje de error. Máximo: 1024
error_code	String	Código de error. Máximo: 9
error_ext_msg	String	Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024

Código de estado: 404

**Tabla 10** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_msg	String	Mensaje de error. Máximo: 1024
error_code	String	Código de error. Máximo: 9
error_ext_msg	String	Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024

Código de estado: 500

**Tabla 11** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_msg	String	Mensaje de error. Máximo: 1024
error_code	String	Código de error. Máximo: 9
error_ext_msg	String	Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024

Solicitudes de ejemplo

GET https://{dcs_endpoint}/v2/{project_id}/instances?offset=0&limit=10&name={name}&status={status}&id={id}&include_failure=true&include_delete=true&name_equal=false

Ejemplo de respuestas

Código de estado: 200

Todas las instancias se enumeran correctamente.

{
  "instance_num" : 1,
  "instances" : [ {
    "publicip_id" : { },
    "vpc_name" : "dcs-beta",
    "charging_mode" : 0,
    "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481",
    "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af",
    "user_name" : "hwclouduser",
    "created_at" : "2022-08-29T09:00:34.335Z",
    "enable_ssl" : false,
    "max_memory" : 128,
    "publicip_address" : null,
    "capacity" : 0,
    "order_id" : null,
    "maintain_begin" : "18:00:00",
    "engine" : "Redis",
    "maintain_end" : "19:00:00",
    "capacity_minor" : ".125",
    "service_upgrade" : false,
    "no_password_access" : true,
    "service_task_id" : "",
    "ip" : "192.168.0.195",
    "used_memory" : 2,
    "access_user" : null,
    "instance_id" : "c830053e-d5a3-4bc0-b6d6-ca37d1ea9dd5",
    "enable_publicip" : false,
    "port" : 6379,
    "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
    "domain_name" : "redis-c830053e-d5a3-4bc0-b6d6-ca37d1ea9dd5.dcs.huaweicloud.com",
    "name" : "dcs-lpvo0829",
    "spec_code" : "redis.ha.xu1.tiny.r2.128",
    "engine_version" : "5.0",
    "status" : "RUNNING",
    "security_group_id" : "securityGroupId",
    "enterprise_project_id" : 0,
    "tags" : [ {
      "key" : 1,
      "value" : "DCS"
    } ],
    "az_codes" : [ "cn-north-7b", "cn-north-7c" ],
    "description" : "Instance description.",
    "cpu_type" : "x86_64",
    "features" : {
      "support_acl" : true,
      "support_transparent_client_ip" : true,
      "support_ssl" : false
    },
    "sub_status" : "normal"
  } ]
}

Código de estado: 400

Solicitud no válida.

{
  "error_code" : "DCS.4800",
  "error_msg" : "Invalid offset in the request."
}

Códigos de estado

Código de estado	Descripción
200	Todas las instancias se enumeran correctamente.
400	Solicitud no válida.
401	Información de autenticación no válida.
403	La solicitud se rechaza.
404	La página solicitada no se encuentra.
500	Error interno del servicio.