DescribeInstanceAttribute - Tair (Redis® OSS-Compatible) - Centro de documentación de Alibaba Cloud

Obtiene los detalles de una instancia de Tair (compatible con Redis).

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

kvstore:DescribeInstanceAttribute

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia.	r-bp1zxszhcgatnx****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	CA40C261-EB72-4EDA-AC57-958722162595
Instances	object
DBInstanceAttribute	array<object>	Los detalles de la instancia.
	array<object>
VpcId	string	El ID de la nube privada virtual (VPC).	vpc-bp1nme44gek34slfc****
PrivateIp	string	La dirección IP privada de la instancia. Nota Este parámetro no se devuelve si el tipo de red de la instancia es red clásica.	172.16.49.***
Capacity	integer	La capacidad de memoria de la instancia. Unidad: MB.	1024
CreateTime	string	La hora en que se creó la instancia. La hora sigue el estándar ISO 8601 en el formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2019-03-06T10:42:03Z
ConnectionDomain	string	El endpoint interno de la instancia.	r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com
IsRds	boolean	Indica si la instancia es administrada por RDS. Valores válidos: true: La instancia es administrada por RDS. false: La instancia no es administrada por RDS.	true
ChargeType	string	El método de facturación de la instancia. Valores válidos: PrePaid: suscripción PostPaid: pago por uso	PostPaid
StorageType	string	El tipo de almacenamiento.	essd_pl1
VpcAuthMode	string	El modo de autenticación para la instancia desplegada en una VPC. Valores válidos: Open: La autenticación por contraseña está habilitada. Close: El acceso sin contraseña está habilitado.	Open
ArchitectureType	string	La arquitectura de la instancia. Valores válidos: cluster: La instancia es una instancia de clúster. standard: La instancia es una instancia estándar. rwsplit: La instancia es una instancia con división de lectura/escritura.	standard
AvailabilityValue	string	La métrica de disponibilidad de la instancia en el mes actual.	100%
NetworkType	string	El tipo de red de la instancia. Valores válidos: CLASSIC: red clásica VPC: VPC	CLASSIC
Port	integer	El puerto de servicio de la instancia.	6379
SecondaryZoneId	string	El ID de la zona secundaria. Nota Si la instancia no está desplegada en una zona secundaria, este parámetro no se devuelve.	cn-hongkong-h
PackageType	string	La edición de la instancia. Valores válidos: standard: edición estándar customized: La edición personalizada está descontinuada.	standard
EngineVersion	string	La versión del motor de base de datos de la instancia. Valores válidos: 2.8, 4.0, 5.0, 6.0 y 7.0.	4.0
Config	string	La configuración de parámetros de la instancia. La configuración está en formato JSON. Para obtener más información, consulte Parámetros. Para ver la configuración del registro de auditoría, llame a la operación DescribeAuditLogConfig.	{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}
VpcCloudInstanceId	string	El ID de la instancia desplegada en una VPC.	r-bp1d72gwl41z7f****
Bandwidth	integer	El ancho de banda de la instancia. Unidad: Mbit/s.	10
InstanceName	string	El nombre de la instancia.	apitest
SecurityIPList	string	La lista blanca de direcciones IP.	127.0.0.1
ShardCount	integer	El número de fragmentos.	2
ReplicaCount	integer	El número de nodos réplica en la zona principal. Nota Los parámetros ReplicaCount y SlaveReplicaCount solo se devuelven para instancias nativas de la nube. Si la instancia utiliza la arquitectura de clúster, estos parámetros especifican el número de nodos réplica por fragmento en las zonas principal y secundaria.	1
SlaveReplicaCount	integer	El número de nodos réplica en la zona secundaria.	1
ReadOnlyCount	integer	El número de nodos de solo lectura en la zona principal. Nota Los parámetros ReadOnlyCount y SlaveReadOnlyCount solo se devuelven para instancias nativas de la nube en las que está habilitada la división de lectura/escritura. Si la instancia utiliza la arquitectura de clúster, estos parámetros especifican el número de nodos de solo lectura por fragmento en las zonas principal y secundaria.	5
SlaveReadOnlyCount	integer	El número de nodos de solo lectura en la zona secundaria. Este parámetro solo se devuelve cuando la división de lectura/escritura está habilitada para una instancia desplegada en múltiples zonas.	2
GlobalInstanceId	string	El ID de la instancia distribuida. Nota Este parámetro solo se devuelve para instancias secundarias de una instancia distribuida.	gr-bp14rkqrhac****
QPS	integer	El máximo de consultas por segundo (QPS).	100000
AuditLogRetention	string	El período de retención del registro de auditoría. Unidad: días. Un valor de 0 indica que la función de registro de auditoría está deshabilitada. Para obtener más información sobre cómo habilitar la función de registro de auditoría, consulte Habilitar el registro de auditoría.	15
ZoneType	string	El tipo de zona de la instancia. Valores válidos: singlezone: zona única doublezone: zona múltiple	singlezone
MaintainStartTime	string	La hora de inicio de la ventana de mantenimiento. La hora está en el formato HH:mmZ y se muestra en UTC.	18:00Z
MaintainEndTime	string	La hora de finalización de la ventana de mantenimiento. La hora está en el formato HH:mmZ y se muestra en UTC.	22:00Z
InstanceClass	string	El tipo de instancia. Para obtener más información, consulte Tipos de instancia.	redis.master.small.default
RealInstanceClass	string	Si la instancia es una instancia de clúster nativa de la nube, este parámetro indica el tipo de instancia real de los fragmentos. En este caso, el parámetro InstanceClass indica un tipo de instancia virtual. Nota Para consultar las tarifas de una instancia de este tipo de instancia, especifique el valor de este parámetro en la operación DescribePrice.	tair.rdb.with.proxy.1g
InstanceId	string	El ID de la instancia.	r-bp1d72gwl41z7f****
InstanceType	string	El motor de base de datos. Valores válidos: Tair Redis: Las instancias de ApsaraDB for Redis Community Edition y las instancias clásicas de tipo memoria de ApsaraDB for Redis Enhanced Edition (Tair) son del motor de base de datos Redis. Memcache	Redis
HasRenewChangeOrder	string	Indica si existe un pedido pendiente de renovación o cambio de configuración para la instancia. Valores válidos: true false	false
InstanceReleaseProtection	boolean	Indica si la protección contra liberación está habilitada para la instancia. Valores válidos: true: La protección contra liberación está habilitada. false: La protección contra liberación está deshabilitada.	false
ReplicationMode	string	La arquitectura de replicación. Valores válidos: master-slave: arquitectura maestro-réplica cluster: arquitectura de clúster, que incluye instancias de división de lectura/escritura y de clúster db: arquitectura de clúster fragmentado nativo de la nube	master-slave
RegionId	string	El ID de la región.	cn-hangzhou
EndTime	string	La hora de vencimiento de la instancia de suscripción. La hora está en el formato yyyy-MM-ddTHH:mm:ssZ y se muestra en UTC.	2019-04-06T10:42:03Z
VSwitchId	string	El ID del vSwitch.	vsw-bp1e7clcw529l773d****
ReplicaId	string	El ID del nodo réplica.	bls-awxxxxxxxxxxxxx
NodeType	string	El tipo de nodo. Valores válidos: double: La instancia tiene dos nodos de datos. single: La instancia tiene un único nodo de datos. readone: La instancia de división de lectura/escritura tiene un nodo de solo lectura. readthree: La instancia de división de lectura/escritura tiene tres nodos de solo lectura.	double
Connections	integer	El número máximo de conexiones.	10000
BackupLogStartTime	string	El punto más antiguo en el tiempo al que se pueden restaurar los datos. La hora está en el formato yyyy-MM-ddTHH:mm:ssZ y se muestra en UTC. Nota Este parámetro solo se devuelve si la función Data Flashback está habilitada para la instancia. Cuando llama a la operación RestoreInstance para realizar una recuperación instantánea de datos, este es el valor más antiguo que se puede especificar para el parámetro RestoreTime.	2021-07-06T05:49:55Z
ResourceGroupId	string	El ID del grupo de recursos al que pertenece la instancia.	rg-acfmyiu4ekp****
ZoneId	string	El ID de la zona.	cn-hongkong-b
InstanceStatus	string	El estado de la instancia. Valores válidos: Normal: La instancia se ejecuta según lo esperado. Creating: La instancia se está creando. Changing: Se está cambiando la configuración de la instancia. Inactive: La instancia está deshabilitada. Flushing: La instancia se está liberando. Released: La instancia está liberada. Transforming: Se está cambiando el método de facturación de la instancia. Migrating: La instancia se está migrando. BackupRecovering: La instancia se está restaurando desde una copia de seguridad. MinorVersionUpgrading: Se está actualizando la versión menor de la instancia. NetworkModifying: Se está cambiando el tipo de red de la instancia. SSLModifying: Se está cambiando el certificado SSL de la instancia. MajorVersionUpgrading: Se está actualizando la versión principal de la instancia. La instancia permanece accesible durante la actualización. Nota Para obtener más información sobre los estados de las instancias y sus impactos, consulte Estados de las instancias.	Normal
Engine	string	El motor de base de datos. El valor es fijo como Redis.	Redis
Storage	string	El espacio de almacenamiento de una instancia de ApsaraDB for Redis Enhanced Edition (Tair) que utiliza discos SSD mejorados (ESSD).	50
CloudType	string	Este parámetro solo se devuelve para instancias de ApsaraDB for Redis creadas en nubes de Alibaba Cloud.	cloudbox
IsOrderCompleted	boolean	Indica si un cambio de configuración está completo. Valores válidos: true: El cambio de configuración está completo o no hay ningún cambio de configuración en curso. false: El cambio de configuración está en curso.	true
IsSupportTDE	boolean	Indica si se admite el cifrado transparente de datos (TDE). Valores válidos: true: Se admite TDE. Esta función solo es compatible con instancias de tipo memoria de ApsaraDB for Redis Enhanced Edition (Tair). false: No se admite TDE.	true
Tags	object
Tag	array<object>	Las etiquetas.
	object	La etiqueta.
Key	string	La clave de la etiqueta.	tagkey
Value	string	El valor de la etiqueta.	tagvalue
AutoSecondaryZone	boolean	Indica si la zona secundaria se selecciona automáticamente. Valores válidos: true: La zona secundaria se selecciona automáticamente. false: La zona secundaria no se selecciona automáticamente.	true
ComputingType	string

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "CA40C261-EB72-4EDA-AC57-958722162595",
  "Instances": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-bp1nme44gek34slfc****",
        "PrivateIp": "172.16.49.***",
        "Capacity": 1024,
        "CreateTime": "2019-03-06T10:42:03Z",
        "ConnectionDomain": "r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com",
        "IsRds": true,
        "ChargeType": "PostPaid",
        "StorageType": "essd_pl1",
        "VpcAuthMode": "Open",
        "ArchitectureType": "standard",
        "AvailabilityValue": "100%",
        "NetworkType": "CLASSIC",
        "Port": 6379,
        "SecondaryZoneId": "cn-hongkong-h",
        "PackageType": "standard",
        "EngineVersion": "4.0",
        "Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
        "VpcCloudInstanceId": "r-bp1d72gwl41z7f****",
        "Bandwidth": 10,
        "InstanceName": "apitest",
        "SecurityIPList": "127.0.0.1",
        "ShardCount": 2,
        "ReplicaCount": 1,
        "SlaveReplicaCount": 1,
        "ReadOnlyCount": 5,
        "SlaveReadOnlyCount": 2,
        "GlobalInstanceId": "gr-bp14rkqrhac****",
        "QPS": 100000,
        "AuditLogRetention": "15",
        "ZoneType": "singlezone",
        "MaintainStartTime": "18:00Z",
        "MaintainEndTime": "22:00Z",
        "InstanceClass": "redis.master.small.default",
        "RealInstanceClass": "tair.rdb.with.proxy.1g",
        "InstanceId": "r-bp1d72gwl41z7f****",
        "InstanceType": "Redis",
        "HasRenewChangeOrder": "false",
        "InstanceReleaseProtection": false,
        "ReplicationMode": "master-slave",
        "RegionId": "cn-hangzhou",
        "EndTime": "2019-04-06T10:42:03Z",
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "ReplicaId": "bls-awxxxxxxxxxxxxx",
        "NodeType": "double",
        "Connections": 10000,
        "BackupLogStartTime": "2021-07-06T05:49:55Z",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hongkong-b",
        "InstanceStatus": "Normal",
        "Engine": "Redis",
        "Storage": "50",
        "CloudType": "cloudbox",
        "IsOrderCompleted": true,
        "IsSupportTDE": true,
        "Tags": {
          "Tag": [
            {
              "Key": "tagkey",
              "Value": "tagvalue"
            }
          ]
        },
        "AutoSecondaryZone": true,
        "ComputingType": ""
      }
    ]
  }
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.