DescribeInstanceAttribute - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Consulta os detalhes de uma instância de banco de dados ApsaraDB Tair (compatível com Redis).

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

kvstore:DescribeInstanceAttribute

get

*DBInstance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	r-bp1zxszhcgatnx****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	CA40C261-EB72-4EDA-AC57-958722162595
Instances	object
DBInstanceAttribute	array<object>	A lista de detalhes da instância.
	array<object>
VpcId	string	O ID da nuvem privada virtual (VPC).	vpc-bp1nme44gek34slfc****
PrivateIp	string	O endereço IP privado da VPC. Nota Este parâmetro não é retornado se o tipo de rede da instância for a rede clássica.	172.16.49.***
Capacity	integer	A capacidade de armazenamento. Unidade: MB.	1024
CreateTime	string	A hora em que a instância foi criada. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2019-03-06T10:42:03Z
ConnectionDomain	string	O endpoint de rede interna da instância.	r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com
IsRds	boolean	Indica se a instância é gerenciada pelo ApsaraDB RDS. Valores válidos: true: Sim. false: Não.	true
ChargeType	string	O método de cobrança. Valores válidos: PrePaid: Assinatura. PostPaid: Pós-pago.	PostPaid
StorageType	string	O tipo de armazenamento.	essd_pl1
VpcAuthMode	string	O modo de autenticação da VPC. Valores válidos: Open: A autenticação por senha é obrigatória. Close: A autenticação por senha está desativada, o que significa que o recurso de acesso sem senha em VPCs está ativado.	Open
ArchitectureType	string	A arquitetura da instância. Valores válidos: cluster: Edição Cluster. standard: Edição Standard. rwsplit: Edição Read/Write Splitting.	standard
AvailabilityValue	string	A métrica de disponibilidade para o mês atual.	100%
NetworkType	string	O tipo de rede. Valores válidos: CLASSIC: Rede clássica. VPC: VPC.	CLASSIC
Port	integer	A porta de serviço da instância.	6379
SecondaryZoneId	string	O ID da zona secundária. Nota Este parâmetro não é retornado se a instância não tiver uma zona secundária.	cn-hongkong-h
PackageType	string	O tipo de plano. Valores válidos: standard: Plano standard. customized: Plano personalizado. Este plano foi descontinuado.	standard
EngineVersion	string	A versão do mecanismo compatível com Redis da instância. Valores válidos: 2.8, 4.0, 5.0, 6.0 e 7.0.	4.0
Config	string	As configurações de parâmetros da instância no formato JSON. Para mais detalhes, consulte Descrição da métrica. Para consultar a configuração do log de auditoria, chame a operação 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	O ID da instância conectada à VPC.	r-bp1d72gwl41z7f****
Bandwidth	integer	A largura de banda. Unidade: MB/s.	10
InstanceName	string	O nome da instância.	apitest
SecurityIPList	string	A lista de permissões de endereços IP.	127.0.0.1
ShardCount	integer	O número de shards. Este parâmetro é aplicável apenas ao site da China.	2
ReplicaCount	integer	O número de nós secundários na zona primária. Nota Os parâmetros ReplicaCount e SlaveReplicaCount são aplicáveis apenas a instâncias nativas da nuvem. Se a instância usar a arquitetura de cluster, esses parâmetros indicam o número de nós secundários nas zonas primária e secundária para um único shard.	1
SlaveReplicaCount	integer	O número de nós secundários na zona secundária.	1
ReadOnlyCount	integer	O número de nós somente leitura na zona primária. Nota Os parâmetros ReadOnlyCount e SlaveReadOnlyCount são aplicáveis apenas a instâncias nativas da nuvem com divisão de leitura/gravação ativada. Se a instância usar a arquitetura de cluster, esses parâmetros indicam o número de nós somente leitura nas zonas primária e secundária para um único shard.	5
SlaveReadOnlyCount	integer	O número de nós somente leitura na zona secundária. Este parâmetro é retornado apenas quando a divisão de leitura/gravação está ativada em uma implantação multizona.	2
GlobalInstanceId	string	O ID da instância distribuída à qual a instância pertence. Nota Este parâmetro é retornado apenas quando a instância é uma instância filha de uma instância distribuída.	gr-bp14rkqrhac****
QPS	integer	O máximo teórico de consultas por segundo (QPS).	100000
AuditLogRetention	string	O período de retenção dos logs de auditoria. Unidade: dias. Um valor de 0 indica que o recurso de log de auditoria não está ativado. Para obter mais informações sobre como ativar o recurso, consulte Ativar o recurso de log de auditoria.	15
ZoneType	string	O tipo de zona. Valores válidos: singlezone: Implantação em zona única. doublezone: Implantação em zona dupla.	singlezone
MaintainStartTime	string	A hora de início da janela de manutenção. A hora é exibida no formato HH:mmZ em UTC.	18:00Z
MaintainEndTime	string	A hora de término da janela de manutenção. A hora é exibida no formato HH:mmZ em UTC.	22:00Z
InstanceClass	string	O tipo de instância. Para obter mais informações, consulte Tipos de instância.	redis.master.small.default
RealInstanceClass	string	Se a instância for uma instância de cluster nativa da nuvem, este parâmetro indica a especificação real do shard da instância, e o parâmetro InstanceClass indica a especificação virtual. Nota Para consultar o preço de uma instância com esta especificação, especifique a especificação da instância retornada por este parâmetro ao chamar a operação DescribePrice.	tair.rdb.with.proxy.1g
InstanceId	string	O ID da instância.	r-bp1d72gwl41z7f****
InstanceType	string	O tipo de instância. Valores válidos: Tair Redis O tipo de instância Redis também é retornado para instâncias Tair clássicas otimizadas para memória. Memcache	Redis
HasRenewChangeOrder	string	Especifica se há um pedido de renovação e upgrade/downgrade não executado. Valores válidos: true: Sim. false: Não.	false
InstanceReleaseProtection	boolean	Indica se a proteção contra liberação está ativada para a instância. Valores válidos: true: Ativada. false: Desativada.	false
ReplicationMode	string	A arquitetura de réplica. Valores válidos: master-slave: Arquitetura primária/secundária da Edição Standard. cluster: Arquitetura de cluster, incluindo a Edição Read/Write Splitting ou a Edição Cluster. db: Arquitetura de cluster com shards nativa da nuvem.	master-slave
RegionId	string	O ID da região.	cn-hangzhou
EndTime	string	A hora em que a instância pré-paga expira. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2019-04-06T10:42:03Z
VSwitchId	string	O ID do vSwitch.	vsw-bp1e7clcw529l773d****
ReplicaId	string	O ID da réplica.	bls-awxxxxxxxxxxxxx
NodeType	string	O tipo de nó. Valores válidos: double: Réplica dupla. single: Réplica única. readone: Instância da Edição Read/Write Splitting com a arquitetura clássica e um nó somente leitura. readthree: Instância da Edição Read/Write Splitting com a arquitetura clássica e três nós somente leitura.	double
Connections	integer	O número máximo de conexões com a instância.	10000
BackupLogStartTime	string	O ponto mais antigo no tempo para o qual os dados podem ser revertidos por flashback. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ em UTC. Nota Este parâmetro é retornado apenas quando o recurso de flashback de dados está ativado para a instância. Ao chamar a operação RestoreInstance para reverter dados por flashback, você pode usar o valor deste parâmetro para determinar o ponto mais antigo no tempo para o qual os dados podem ser revertidos. Este também é o ponto mais antigo no tempo que pode ser especificado para RestoreTime.	2021-07-06T05:49:55Z
ResourceGroupId	string	O ID do grupo de recursos ao qual a instância pertence.	rg-acfmyiu4ekp****
ZoneId	string	O ID da zona.	cn-hongkong-b
InstanceStatus	string	O status da instância. Valores válidos: Normal: Normal. Creating: Criando. Changing: Modificando. Inactive: Desativada. Flushing: Purga. Released: Liberada. Transforming: Transformando. Migrating: Migrando. BackupRecovering: Restaurando do backup. MinorVersionUpgrading: Upgrade de versão secundária em andamento. NetworkModifying: Modificando rede. SSLModifying: Modificando SSL. MajorVersionUpgrading: Upgrade de versão principal do mecanismo em andamento. A instância permanece acessível. Nota Para obter mais informações sobre os status das instâncias e seus impactos, consulte Status e impactos das instâncias.	Normal
Engine	string	O mecanismo de banco de dados. O valor é fixo como Redis.	Redis
Storage	string	O espaço de armazenamento das instâncias Tair ESSD.	50
CloudType	string	Este parâmetro é exibido apenas para instâncias CloudBox.	cloudbox
IsOrderCompleted	boolean	Indica se o pedido da instância foi concluído. Este parâmetro é usado para determinar se um pedido de alteração de especificação atingiu o estado final. Valores válidos: true: A alteração de especificação foi concluída ou nenhuma alteração de especificação foi realizada. false: A alteração de especificação está em andamento.	true
IsSupportTDE	boolean	Indica se o tipo e a versão da instância suportam TDE. Um valor true indica que o TDE é suportado. Um valor false indica que o TDE não é suportado. O TDE é suportado por instâncias RDB nativas da nuvem Tair otimizadas para memória das versões 6.0, 7.0 e 8.1, e instâncias de desempenho aprimorado .amber. de disco local da versão 5.0.	true
Tags	object
Tag	array<object>	As informações da tag.
	object	As informações da tag.
Key	string	A chave da tag.	tagkey
Value	string	O valor da tag.	tagvalue
AutoSecondaryZone	boolean	Indica se a zona secundária é atribuída automaticamente. Valores válidos: true: Atribuída automaticamente. false: Não atribuída automaticamente.	true
ComputingType	string	O tipo de recurso de computação da instância.	Ecs

Exemplos

Resposta de sucesso

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": "Ecs"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.