Use DATASOURCE::REDIS::Instances to query information about Tair (Redis OSS-compatible) instances - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Syntax

{
  "Type": "DATASOURCE::REDIS::Instances",
  "Properties": {
    "ArchitectureType": String,
    "EngineVersion": String,
    "EditionType": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "VSwitchId": String,
    "InstanceClass": String,
    "Expired": String,
    "VpcId": String,
    "PrivateIp": String,
    "InstanceStatus": String,
    "ChargeType": String,
    "NetworkType": String,
    "SearchKey": String,
    "GlobalInstance": String,
    "InstanceType": String,
    "InstanceIds": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ArchitectureType	String	No	Yes	A arquitetura da instância.	Valores válidos: cluster: arquitetura em cluster standard: arquitetura padrão rwsplit: arquitetura de separação leitura/escrita
EngineVersion	String	No	Yes	A versão do mecanismo de banco de dados.	Valores válidos: 2.8 4.0 5.0 6.0
EditionType	String	No	Yes	A edição da instância.	Valores válidos: Community: Community Edition Enterprise: Tair (Enterprise Edition)
ZoneId	String	No	Yes	O ID da zona da instância.	Nenhuma.
ResourceGroupId	String	No	Yes	O ID do grupo de recursos.	Nenhuma.
VSwitchId	String	No	Yes	O ID do vSwitch.	Nenhuma.
InstanceClass	String	No	Yes	O tipo da instância.	Nenhuma.
Expired	String	No	Yes	Indica se a instância está expirada.	Valores válidos: true false
VpcId	String	No	Yes	O ID do VPC.	Nenhuma.
PrivateIp	String	No	Yes	O endereço IP privado da instância no VPC.	Nenhuma.
InstanceStatus	String	No	Yes	O status da instância.	Valores válidos: Normal: a instância opera conforme esperado. Creating: a instância está sendo criada. Changing: a instância está sendo modificada. Inactive: a instância está desativada. Flushing: a instância está sendo liberada. Released: a instância foi liberada. Transforming: a instância está em processo de transformação. Unavailable: a instância está parada. Error: ocorreu uma falha na criação da instância. Migrating: a instância está sendo migrada. BackupRecovering: a instância está sendo restaurada a partir de um backup. MinorVersionUpgrading: uma versão secundária da instância está sendo atualizada. NetworkModifying: as configurações de rede da instância estão sendo modificadas. SSLModifying: as configurações de SSL da instância estão sendo modificadas. MajorVersionUpgrading: a versão principal da instância está sendo atualizada. A instância permanece acessível durante o processo.
ChargeType	String	No	Yes	O método de faturamento.	Valores válidos: PrePaid: assinatura PostPaid: pagamento conforme o uso
NetworkType	String	No	Yes	O tipo de rede.	Valores válidos: CLASSIC VPC
SearchKey	String	No	Yes	A palavra-chave para pesquisa aproximada. Pode corresponder a parte do nome ou do ID de uma instância.	Nenhuma.
GlobalInstance	String	No	Yes	Indica se as instâncias filhas de uma instância distribuída devem ser retornadas.	Valores válidos: true false
InstanceType	String	No	Yes	A categoria da instância.	Valores válidos: Tair Redis Memcache
InstanceIds	String	No	Yes	Os IDs das instâncias a consultar.	Nota Para especificar múltiplos IDs de instância, separe-os com vírgulas (,).
RefreshOptions	String	No	Yes	A política de atualização dos recursos de source de dados quando a stack é atualizada.	Valores válidos: Never (padrão): não atualiza os recursos de source de dados quando a stack é atualizada. Always: atualiza os recursos de source de dados quando a stack é atualizada.

Valores de retorno (Fn::GetAtt)

InstanceIds: os IDs das instâncias.
Instances: detalhes das instâncias.

Property	Type	Description	Constraint
InstanceIds	List	Os IDs das instâncias.	Nenhuma.
Instances	List	Detalhes das instâncias.	Nenhuma.
VpcId	String	O ID do VPC.	Nenhuma.
PrivateIp	String	O endereço IP privado da instância no VPC.	Nota Esta propriedade não é retornada se a instância estiver implantada na rede clássica.
Capacity	Number	A capacidade de armazenamento da instância.	Unidade: MB.
ReplacateId	String	O ID lógico da instância distribuída.	Nenhuma.
CreateTime	String	A data e hora de criação da instância.	Nenhuma.
ConnectionDomain	String	O endpoint privado da instância.	Nenhuma.
IsRds	Boolean	Indica se a instância é gerenciada pelo ApsaraDB RDS.	Valores válidos: true false
ChargeType	String	O método de faturamento.	Valores válidos: PrePaid: assinatura PostPaid: pagamento conforme o uso
ArchitectureType	String	O tipo de arquitetura.	Valores válidos: cluster: arquitetura de cluster standard: arquitetura padrão SplitRW: arquitetura de separação de leitura/gravação NULL (padrão): todos os tipos de arquitetura
NetworkType	String	O tipo de rede.	Valores válidos: CLASSIC VPC
ConnectionMode	String	O modo de conexão da instância.	Valores válidos: Standard: modo padrão Safe: modo proxy
Port	Number	A porta de service da instância.	Nenhuma.
SecondaryZoneId	String	O ID da zona secundária.	Nota SecondaryZoneId não é retornado quando ZoneId retorna um valor que indica múltiplos IDs de zona, como "cn-hangzhou-MAZ10(h,i)".
EngineVersion	String	A versão do mecanismo de banco de dados.	Valores válidos: 2.8 4.0 5.0 6.0
PackageType	String	O tipo de plano.	Valores válidos: standard customized
Config	String	As configurações de parâmetros da instância.	Para mais informações, consulte Visão geral dos parâmetros de configuração.
Bandwidth	Number	A largura de banda da instância.	Unidade: MB/s.
InstanceName	String	O nome da instância.	Nenhuma.
ShardCount	Number	O número de nós de dados na instância de cluster.	Nota Esta propriedade é retornada apenas quando a instância é uma instância de cluster que utiliza discos em cloud.
UserName	String	O nome de usuário utilizado para conectar-se à instância.	Por padrão, é retornado um nome de usuário com o mesmo nome do ID da instância.
GlobalInstanceId	String	O ID da instância distribuída.	Nota Esta propriedade é retornada apenas quando a instância é uma instância filha de uma instância distribuída.
QPS	Number	As consultas por segundo (QPS).	Nenhuma.
InstanceClass	String	O tipo de instância.	Nenhuma.
DestroyTime	String	A data e hora em que a instância foi permanentemente excluída.	Nenhuma.
InstanceType	String	A categoria da instância.	Valores válidos: Tair Redis Memcache
HasRenewChangeOrder	Boolean	Indica se existe um pedido de renovação ou alteração de configuração pendente.	Valores válidos: true false
SearchKey	String	A palavra-chave para busca difusa. A palavra-chave corresponde a parte de um ID ou descrição de instância.	Nenhuma.
EndTime	String	A data e hora de expiração da instância com assinatura.	Nenhuma.
VSwitchId	String	O ID do vSwitch.	Nenhuma.
NodeType	String	O tipo de nó.	Valores válidos: double: mestre-réplica single: standalone
Connections	Number	O número máximo de conexões suportadas pela instância.	Nenhuma.
ResourceGroupId	String	O ID do grupo de recursos.	Nenhuma.
ZoneId	String	O ID da zona.	Nenhuma.
InstanceStatus	String	O status da instância.	Valores válidos: Normal: a instância está funcionando conforme o esperado. Creating: a instância está sendo criada. Changing: a instância está sendo modificada. Inactive: a instância está desabilitada. Flushing: a instância está sendo liberada. Released: a instância foi liberada. Transforming: a instância está sendo transformada. Migrating: a instância está sendo migrada. Unavailable: a instância está interrompida. Error: a criação da instância falhou. BackupRecovering: a instância está sendo restaurada a partir de um backup. MinorVersionUpgrading: uma versão secundária da instância está sendo atualizada. NetworkModifying: as configurações de rede da instância estão sendo modificadas. SSLModifying: as configurações SSL da instância estão sendo modificadas. MajorVersionUpgrading: a versão principal da instância está sendo atualizada. A instância permanece acessível durante o processo.
CloudType	String	Esta propriedade é retornada apenas quando a instância está em um cloud box.	Nenhuma.
EditionType	String	A edição da instância.	Valores válidos: Community: Community Edition Enterprise: Tair (Enterprise Edition)
Tags	Map	As tags da instância.	Exemplo: `{ "Value" : "Community Edition", "Key" : "Type" }`
InstanceId	String	O ID da instância.	Nenhuma.

Exemplos

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceIds": {
      "Type": "String",
      "Description": "The IDs of instances.\nIf you specify multiple instance IDs, separate the instance IDs with commas (,)."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::REDIS::Instances",
      "Properties": {
        "InstanceIds": {
          "Ref": "InstanceIds"
        }
      }
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "The list of The Redis instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "The list of The Redis instance Ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceIds:
    Type: String
    Description: |-
      The IDs of instances.
      If you specify multiple instance IDs, separate the instance IDs with commas (,).
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::REDIS::Instances
    Properties:
      InstanceIds:
        Ref: InstanceIds
Outputs:
  Instances:
    Description: The list of The Redis instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Instances
  InstanceIds:
    Description: The list of The Redis instance Ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceIds