Consulta informações sobre uma instância do Tair (compatível com Redis OSS).
Sintaxe
{
"Type": "DATASOURCE::REDIS::Instance",
"Properties": {
"DBInstanceId": String,
"RefreshOptions": String
}
}Propriedades
|
Propriedade |
Tipo |
Obrigatória |
Editável |
Descrição |
Restrição |
|
DBInstanceId |
String |
Sim |
Sim |
ID da instância. |
Nenhuma. |
|
RefreshOptions |
String |
Não |
Sim |
Política de atualização dos recursos da fonte de dados durante atualizações da pilha. |
Valores válidos:
|
Valores de retorno
Fn::GetAtt
SecurityIpGroupAttribute: atributo da lista de permissões de endereços IP.
EndTime: hora de expiração da instância.
ResourceGroupId: ID do grupo de recursos ao qual a instância pertence.
Config: configuração de parâmetros da instância.
Port: porta de serviço da instância.
HasRenewChangeOrder: indica se existe um pedido pendente de renovação ou alteração de configuração.
SecurityIpGroupName: nome da lista de permissões de endereços IP.
ShardCount: número de shards de dados na instância cluster.
ConnectionDomain: endpoint privado da instância.
MaintainEndTime: hora final da janela de manutenção.
Capacity: capacidade de armazenamento da instância.
DBInstanceId: ID da instância.
PrivateIp: endereço IP privado da instância.
Qps: consultas por segundo (QPS).
NetworkType: tipo de rede.
PackageType: tipo de plano.
InstanceReleaseProtection: status de proteção contra liberação da instância.
Bandwidth: largura de banda da instância.
PaymentType: método de faturamento.
InstanceType: categoria da instância.
Tags: detalhes das tags.
MaintainStartTime: hora inicial da janela de manutenção.
DBInstanceName: nome da instância.
ReplacateId: ID lógico da instância distribuída.
ArchitectureType: tipo de arquitetura.
SecurityIps: endereços IP na lista de permissões de endereços IP.
EngineVersion: versão do mecanismo de banco de dados da instância.
ZoneId: ID da zona.
CloudType: propriedade retornada apenas se a instância estiver em uma cloud box.
VSwitchId: ID do vSwitch.
SecurityGroupId: ID do grupo de segurança.
CreateTime: hora de criação da instância.
ReadOnlyCount: número de réplicas de leitura. Disponível apenas para instâncias com divisão de leitura e gravação que utilizam discos em nuvem.
InstanceClass: tipo da instância.
IsRds: indica se o ApsaraDB RDS gerencia a instância.
SecondaryZoneId: ID da zona secundária.
VpcId: ID da virtual private cloud (VPC).
VpcAuthMode: modo de autenticação da VPC.
VpcCloudInstanceId: ID da instância na VPC.
Exemplos
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
DBInstanceId:
Description:
en: Database instance id.
Required: true
Type: String
Resources:
ExtensionDataSource:
Properties:
DBInstanceId:
Ref: DBInstanceId
Type: DATASOURCE::REDIS::Instance
Outputs:
ArchitectureType:
Description: Architecture type.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ArchitectureType
Bandwidth:
Description: Bandwidth.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Bandwidth
Capacity:
Description: Capacity.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Capacity
CloudType:
Description: Cloud category.
Value:
Fn::GetAtt:
- ExtensionDataSource
- CloudType
Config:
Description: Config.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Config
ConnectionDomain:
Description: Connection domain.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ConnectionDomain
CreateTime:
Description: Create time.
Value:
Fn::GetAtt:
- ExtensionDataSource
- CreateTime
DBInstanceId:
Description: Database instance id.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceId
DBInstanceName:
Description: Instance name.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceName
EndTime:
Description: End time.
Value:
Fn::GetAtt:
- ExtensionDataSource
- EndTime
EngineVersion:
Description: Engine version.
Value:
Fn::GetAtt:
- ExtensionDataSource
- EngineVersion
HasRenewChangeOrder:
Description: Has renew change order.
Value:
Fn::GetAtt:
- ExtensionDataSource
- HasRenewChangeOrder
InstanceClass:
Description: Instance class.
Value:
Fn::GetAtt:
- ExtensionDataSource
- InstanceClass
InstanceReleaseProtection:
Description: Instance release protection.
Value:
Fn::GetAtt:
- ExtensionDataSource
- InstanceReleaseProtection
InstanceType:
Description: Instance type.
Value:
Fn::GetAtt:
- ExtensionDataSource
- InstanceType
IsRds:
Description: is RDS.
Value:
Fn::GetAtt:
- ExtensionDataSource
- IsRds
MaintainEndTime:
Description: Maintain end time.
Value:
Fn::GetAtt:
- ExtensionDataSource
- MaintainEndTime
MaintainStartTime:
Description: Maintain start time.
Value:
Fn::GetAtt:
- ExtensionDataSource
- MaintainStartTime
NetworkType:
Description: Network type.
Value:
Fn::GetAtt:
- ExtensionDataSource
- NetworkType
PackageType:
Description: Package type.
Value:
Fn::GetAtt:
- ExtensionDataSource
- PackageType
PaymentType:
Description: Payment type.
Value:
Fn::GetAtt:
- ExtensionDataSource
- PaymentType
Port:
Description: Port.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Port
PrivateIp:
Description: Private IP.
Value:
Fn::GetAtt:
- ExtensionDataSource
- PrivateIp
Qps:
Description: QPS.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Qps
ReadOnlyCount:
Description: 'The number of read-only nodes. This parameter is only applicable
to the creation of read-write splitting instances in the cloud disk version.
You can use this parameter to customize the number of read-only nodes. Valid
values: 1 to 5.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- ReadOnlyCount
ReplacateId:
Description: Replacate id.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ReplacateId
ResourceGroupId:
Description: Resource group id.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ResourceGroupId
SecondaryZoneId:
Description: The ID of the standby zone. You can call the [DescribeZones](~~ 94527
~~) operation.
Value:
Fn::GetAtt:
- ExtensionDataSource
- SecondaryZoneId
SecurityGroupId:
Description: Security group id.
Value:
Fn::GetAtt:
- ExtensionDataSource
- SecurityGroupId
SecurityIpGroupAttribute:
Description: Security IP group attribute.
Value:
Fn::GetAtt:
- ExtensionDataSource
- SecurityIpGroupAttribute
SecurityIpGroupName:
Description: Security IP group name.
Value:
Fn::GetAtt:
- ExtensionDataSource
- SecurityIpGroupName
SecurityIps:
Description: Security IPs.
Value:
Fn::GetAtt:
- ExtensionDataSource
- SecurityIps
ShardCount:
Description: The number of slices. This parameter is only applicable to creating
a cloud disk cluster architecture instance. You can use this parameter to customize
the number of slices.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ShardCount
Tags:
Description: Tags.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Tags
VSwitchId:
Description: Vswitch id.
Value:
Fn::GetAtt:
- ExtensionDataSource
- VSwitchId
VpcAuthMode:
Description: Vpc auth mode.
Value:
Fn::GetAtt:
- ExtensionDataSource
- VpcAuthMode
VpcCloudInstanceId:
Description: Vpc cloud instance id.
Value:
Fn::GetAtt:
- ExtensionDataSource
- VpcCloudInstanceId
VpcId:
Description: Vpc id.
Value:
Fn::GetAtt:
- ExtensionDataSource
- VpcId
ZoneId:
Description: Zone id.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ZoneId
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"DBInstanceId": {
"Type": "String",
"Description": {
"en": "Database instance id."
},
"Required": true
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::REDIS::Instance",
"Properties": {
"DBInstanceId": {
"Ref": "DBInstanceId"
}
}
}
},
"Outputs": {
"SecurityIpGroupAttribute": {
"Description": "Security IP group attribute.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SecurityIpGroupAttribute"
]
}
},
"EndTime": {
"Description": "End time.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"EndTime"
]
}
},
"ResourceGroupId": {
"Description": "Resource group id.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ResourceGroupId"
]
}
},
"Config": {
"Description": "Config.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Config"
]
}
},
"Port": {
"Description": "Port.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Port"
]
}
},
"HasRenewChangeOrder": {
"Description": "Has renew change order.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"HasRenewChangeOrder"
]
}
},
"SecurityIpGroupName": {
"Description": "Security IP group name.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SecurityIpGroupName"
]
}
},
"ShardCount": {
"Description": "The number of slices. This parameter is only applicable to creating a cloud disk cluster architecture instance. You can use this parameter to customize the number of slices.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ShardCount"
]
}
},
"ConnectionDomain": {
"Description": "Connection domain.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ConnectionDomain"
]
}
},
"MaintainEndTime": {
"Description": "Maintain end time.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"MaintainEndTime"
]
}
},
"Capacity": {
"Description": "Capacity.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Capacity"
]
}
},
"DBInstanceId": {
"Description": "Database instance id.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceId"
]
}
},
"PrivateIp": {
"Description": "Private IP.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"PrivateIp"
]
}
},
"Qps": {
"Description": "QPS.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Qps"
]
}
},
"NetworkType": {
"Description": "Network type.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"NetworkType"
]
}
},
"PackageType": {
"Description": "Package type.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"PackageType"
]
}
},
"InstanceReleaseProtection": {
"Description": "Instance release protection.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"InstanceReleaseProtection"
]
}
},
"Bandwidth": {
"Description": "Bandwidth.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Bandwidth"
]
}
},
"PaymentType": {
"Description": "Payment type.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"PaymentType"
]
}
},
"InstanceType": {
"Description": "Instance type.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"InstanceType"
]
}
},
"Tags": {
"Description": "Tags.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Tags"
]
}
},
"MaintainStartTime": {
"Description": "Maintain start time.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"MaintainStartTime"
]
}
},
"DBInstanceName": {
"Description": "Instance name.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceName"
]
}
},
"ReplacateId": {
"Description": "Replacate id.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ReplacateId"
]
}
},
"ArchitectureType": {
"Description": "Architecture type.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ArchitectureType"
]
}
},
"SecurityIps": {
"Description": "Security IPs.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SecurityIps"
]
}
},
"EngineVersion": {
"Description": "Engine version.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"EngineVersion"
]
}
},
"ZoneId": {
"Description": "Zone id.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ZoneId"
]
}
},
"CloudType": {
"Description": "Cloud category.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"CloudType"
]
}
},
"VSwitchId": {
"Description": "Vswitch id.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"VSwitchId"
]
}
},
"SecurityGroupId": {
"Description": "Security group id.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SecurityGroupId"
]
}
},
"CreateTime": {
"Description": "Create time.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"CreateTime"
]
}
},
"ReadOnlyCount": {
"Description": "The number of read-only nodes. This parameter is only applicable to the creation of read-write splitting instances in the cloud disk version. You can use this parameter to customize the number of read-only nodes. Valid values: 1 to 5.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ReadOnlyCount"
]
}
},
"InstanceClass": {
"Description": "Instance class.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"InstanceClass"
]
}
},
"IsRds": {
"Description": "is RDS.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"IsRds"
]
}
},
"SecondaryZoneId": {
"Description": "The ID of the standby zone. You can call the [DescribeZones](~~ 94527 ~~) operation.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SecondaryZoneId"
]
}
},
"VpcId": {
"Description": "Vpc id.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"VpcId"
]
}
},
"VpcAuthMode": {
"Description": "Vpc auth mode.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"VpcAuthMode"
]
}
},
"VpcCloudInstanceId": {
"Description": "Vpc cloud instance id.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"VpcCloudInstanceId"
]
}
}
}
}