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/ APIs fuera de fecha (no disponibles pronto)/ API de gestión del ciclo de vida/ Consulta de todas las instancias DCS de un inquilino
Actualización más reciente 2022-11-09 GMT+08:00
Ver PDF
Compartir

Consulta de todas las instancias DCS de un inquilino

Función

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

URI

GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&isExactMatchName={isExactMatchName}&ip={ip}&tags={key}={value}

Tabla 1 describe los parámetros.
Tabla 1 Descripción del parámetro

Parámetro

Tipo

Obligatorio

Descripción

project_id

String

Sí

ID.

start

Integer

No

Número de inicio para consultar instancias de DCS. No puede ser inferior a 1.

De forma predeterminada, el número de inicio es 1.

limit

Integer

No

Número de instancias de DCS mostradas en cada página.

Valor mínimo: 1

Valor máximo: 2000

Si este parámetro no se especifica, se mostrará un máximo de 1000 instancias DCS en cada página.

name

String

No

Nombre de instancia de DCS.

id

String

No

ID de instancia.

status

String

No

Estado de la instancia de DCS. Para obtener más información sobre el estado, consulte Estado de instancia de DCS.

ip

String

No

Dirección IP para conectarse a la instancia DCS

includeFailure

String

No

Un indicador de si el número de instancias de DCS que no se crearon se devolverá al llamante de la API.

Opciones:

  • true: El número de instancias de DCS que no se crearon se devolverá al llamante de la API.
  • false u otros: el número de instancias de DCS que no se crearon no se devolverá al llamante de la API.

isExactMatchName

String

No

Un indicador de si se debe realizar una coincidencia exacta o difusa basada en el nombre de la instancia.

Opciones:

  • true: coincidencia exacta
  • false: coincidencia difusa

Valor predeterminado: false.

tags

Array of objects

No

Consulta basada 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 (,).

Ejemplo

GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&isExactMatchName=false

Or

GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?tags=dcs001=001,dcs002=002

Solicitud

Parámetros de solicitud

Ninguno

Solicitud de ejemplo

Ninguno

Respuesta

Parámetros de respuesta

Tabla 2 describe los parámetros de respuesta.
Tabla 2 Descripción del parámetro

Parámetro

Tipo

Descripción

instances

Array

Matriz de detalles de la instancia de DCS.

instance_num

Integer

Número de instancias de DCS.
Tabla 3 Descripción del parámetro de la matriz de instancia

Parámetro

Tipo

Descripción

name

String

Nombre de instancia de DCS.

engine

String

Motor de caché.

capacity

Integer

Capacidad de caché.

Unidad: GB.

ip

String

Dirección IP para conectarse a la instancia 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.

domainName

String

Nombre de dominio de la instancia.

port

Integer

Número de puerto del nodo de caché.

status

String

Estado de la instancia de caché. Para obtener más información sobre el estado, consulte Estado de instancia de DCS.

max_memory

Integer

Tamaño total de la memoria.

Unidad: MB.

used_memory

Integer

Tamaño de la memoria utilizada.

Unidad: MB.

instance_id

String

ID de instancia de DCS.

resource_spec_code

String

Especificaciones de recursos.

  • dcs.single_node: indica una instancia DCS en modo de nodo único.
  • dcs.master_standby: indica una instancia DCS en modo maestro/standby.
  • dcs.cluster: indica una instancia de DCS en modo de clúster.

engine_version

String

Versión del motor de caché.

internal_version

String

Versión interna de DCS.

charging_mode

Integer

Modo de facturación. 0: pago por uso.

capacity_minor

String

Capacidad de caché a pequeña escala. Unidad: GB.

vpc_id

String

ID de VPC.

vpc_name

String

Nombre de la VPC.

created_at

String

Hora en la que se crea la instancia DCS. Por ejemplo, 2017-03-31T12:24:46.297Z.

error_code

String

Código de error devuelto cuando la instancia DCS no se crea o es anormal. Para obtener más información sobre los códigos de error, consulte Códigos de estado.

user_id

String

ID de usuario.

user_name

String

Nombre de usuario.

maintain_begin

String

Hora en la que comienza la ventana de tiempo de mantenimiento. Formato: HH:mm:ss.

maintain_end

String

Tiempo en el que finaliza la ventana de tiempo de mantenimiento. Formato: HH:mm:ss.

no_password_access

String

Un indicador de si se puede acceder a una instancia de DCS en modo sin contraseña.

  • true: indica que se puede acceder a una instancia de DCS sin una contraseña.
  • false: indica que solo se puede acceder a una instancia de DCS después de la autenticación de contraseña.

access_user

String

Nombre de usuario utilizado para acceder a una instancia de DCS con autenticación de contraseña.

enable_publicip

Boolean

Un indicador de si el acceso público está habilitado para una instancia de DCS en Redis.

  • true: habilitado.
  • false: deshabilitado.

publicip_address

String

Dirección IP elástica enlazada a una instancia de DCS en Redis.

El valor del parámetro es null si el acceso público está deshabilitado.

publicip_id

String

ID de la dirección IP elástica enlazada a una instancia de DCS en Redis.

El valor del parámetro es null si el acceso público está deshabilitado.

enable_ssl

Boolean

Un indicador de si se debe habilitar SSL para el acceso público a una instancia de DCS en Redis.

  • true: habilitado.
  • false: deshabilitado.

service_upgrade

Boolean

Indica si se ha creado una tarea de actualización para una instancia de DCS.

  • 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.

security_group_id

String

Nombre del grupo de seguridad.

tags

Array of objects

Clave y valor de la etiqueta de instancia.

Ejemplo de respuesta

Código de estado

Tabla 4 describe el código de estado de las operaciones exitosas. Para obtener más información sobre otros códigos de estado, consulte Tabla 1.

Tabla 4 Código de estado

Código de estado

Descripción

200

Todas las instancias de DCS del inquilino consultadas correctamente.