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 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 /v1.0/{project_id}/instances/{instance_id}

Tabla 1 describe los parámetros.

**Tabla 1** Descripción del parámetro
Parámetro	Tipo	Obligatorio	Descripción
project_id	String	Sí	Para obtener más información sobre cómo obtener el valor de este parámetro, consulte Obtención de un ID de proyecto.
instance_id	String	Sí	ID de la instancia que se va a consultar

Solicitud

Parámetros de solicitud

None.

Solicitud de ejemplo

URL de solicitud:

GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}

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
name	String	Nombre de instancia de DCS.
engine	String	Motor de instancia DCS.
capacity	Integer	Capacidad de caché de instancia de DCS. 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.
libos	Boolean	true: Esta instancia es una instancia de libos. false: Esta instancia no es una instancia de libos.
description	String	Breve descripción de la instancia 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: indicates a DCS instance in single-node mode. 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é de una instancia DCS de un solo nodo y pequeña.
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 se encuentra en estado anormal. Para obtener más información sobre los códigos de error, consulte Tabla 3.
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. Opciones: true: habilitado. false: 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.
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.
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.
available_zones	Array	zona de disponibilidad donde reside un nodo de caché. El valor de este parámetro en la respuesta contiene un ID de zona de disponibilidad.
subnet_id	String	ID de subred.
security_group_id	String	ID del grupo de seguridad.
backend_addrs	String	Dirección de backend de una instancia de clúster.
product_id	String	ID del producto
security_group_name	String	Nombre del grupo de seguridad.
subnet_name	String	Nombre de subred.
subnet_cidr	String	Segmento de subred.
order_id	String	ID de pedido.
instance_backup_policy	JSON	Política de copia de respaldo. Este parámetro está disponible para instancias DCS maestras/en espera y de clúster. Para obtener más información, consulte Tabla 4 y Tabla 5.
tags	Array of objects	Clave y valor de la etiqueta de instancia.

**Tabla 3** Códigos de error
Código de error	Descripción
dcs.00.0007	Error del sistema.
dcs.01.0001	Error interno del servicio.
dcs.01.0002	Error interno del servicio.
dcs.01.0003	Error interno del servicio.
dcs.02.0001	Error al crear la VPC.
dcs.02.0002	Error al crear la VPC.
dcs.02.0003	Error al crear el grupo de seguridad.
dcs.02.0004	Error al crear la subred.
dcs.02.0005	Estado de subred anormal.
dcs.03.0001	Error al crear el ECS.
dcs.03.0002	Error al crear el ECS.
dcs.03.0003	Error al crear el ECS.
dcs.03.0004	Error al crear el ECS.
dcs.03.0005	Error al vincular la NIC al ECS.
dcs.03.0007	Error al iniciar el ECS.
dcs.03.0008	Error al iniciar el ECS.
dcs.03.0009	Error al detener el ECS.
dcs.03.0017	Algunos nodos de la instancia presentan fallas.
dcs.04.0002	Error al desplegar la instancia.
dcs.04.0003	Error al conectarse a la instancia.
dcs.04.0004	Ambos nodos de caché están en el estado master. Es posible que se generen errores de conexión entre los nodos principal y en standby.

Ejemplo de respuesta

{
	"name": "dcs-125d",
	"engine": "Redis",
	"capacity": 64,
	"ip": "192.168.1.48",
	"domainName": "XXXXXX",
	"port": 6379,
	"status": "RUNNING",
	"libos": false,
	"description": null,
	"task": null,
	"max_memory": 65536,
	"used_memory": 33,
	"instance_id": "979e9a6b-e2f5-4b5d-8e98-fea495ea27a1",
	"resource_spec_code": "dcs.cluster",
	"engine_version": "3.0",
	"internal_version": null,
	"charging_mode": 0,
	"capacity_minor": null,
	"vpc_id": "d1e8008d-8182-4c86-a142-1ae9349bdc64",
	"vpc_name": "vpc-807d",
	"task_status": null,
	"created_at": "2018-12-11T07:24:18.149Z",
	"error_code": null,
	"user_id": "9bfac09d9bcd4eb7bb1465a7bcff815b",
	"user_name": "r00209145",
	"maintain_begin": "02:00:00",
	"maintain_end": "06:00:00",
	"no_password_access": "true",
	"access_user": null,
	"enable_publicip": false,
	"publicip_id": null,
	"publicip_address": null,
	"enable_ssl": false,
	"service_upgrade": false,
	"service_task_id": null,
	"is_free": null,
	"enterprise_project_id": "0",
	"available_zones": ["f84448fd537f46078dd8bd776747f573"],
	"subnet_id": "9b32218f-6389-485a-912e-076fe9df6fa7",
	"security_group_id": "ecefdad9-c8be-42aa-9d5d-9ab46a221240",
	"backend_addrs": ["192.168.1.136:6379",
	"192.168.1.224:6379"],
	"product_id": "00301-17063-0--0",
	"security_group_name": "sg--test-hanwang",
	"subnet_name": "subnet-7e46",
	"order_id": null,
	"subnet_cidr": "192.168.1.0/24",
	"instance_backup_policy": null,
        "tags": [
        {
            "key": "dcs001",
            "value": "001"
        },
        {
            "key": "dcs002",
            "value": "002"
        }
        ],
	"enterprise_project_name": null
}