DATASOURCE::MONGODB::Instances - consultar instâncias do ApsaraDB for MongoDB no ROS - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "DATASOURCE::MONGODB::Instances",
  "Properties": {
    "EngineVersion": String,
    "ReplicationFactor": String,
    "DBInstanceStatus": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "DBInstanceClass": String,
    "VSwitchId": String,
    "DBInstanceType": String,
    "Expired": Boolean,
    "ConnectionDomain": String,
    "VpcId": String,
    "DBInstanceId": String,
    "ChargeType": String,
    "NetworkType": String,
    "DBInstanceDescription": String,
    "Tags": List,
    "RefreshOptions": String
  }
}

Propriedades

Propriedade	Tipo	Obrigatória	Editável	Descrição	Restrição
EngineVersion	String	Não	Sim	Versão do mecanismo de banco de dados.	Valores válidos: 5.0 4.4 4.2 4.0 3.4
ReplicationFactor	String	Não	Sim	Número de nós em uma instância de conjunto de réplicas.	Valores válidos: 3 5 7
DBInstanceStatus	String	Não	Sim	Status da instância.	Valores válidos: Estados da instância.
ZoneId	String	Não	Sim	ID da zona.	Chame a operação DescribeRegions para consultar as zonas compatíveis.
ResourceGroupId	String	Não	Sim	ID do grupo de recursos.	Nenhuma.
DBInstanceClass	String	Não	Sim	Especificação da instância.	Valores válidos: Especificações de instância.
VSwitchId	String	Não	Sim	ID do vSwitch.	Nenhuma.
DBInstanceType	String	Não	Sim	Arquitetura da instância.	Valores válidos: sharding: instância de cluster fragmentado replicate (padrão): instância de conjunto de réplicas ou instância independente serverless: instância serverless
Expired	Boolean	Não	Sim	Indica se a instância expirou.	Valores válidos: true false
ConnectionDomain	String	Não	Sim	Endpoint do nó.	Chame a operação DescribeDBInstanceAttribute para consultar os endpoints dos nós.
VpcId	String	Não	Sim	ID da VPC.	Nenhuma.
DBInstanceId	String	Não	Sim	ID da instância.	Nenhuma.
ChargeType	String	Não	Sim	Método de faturamento.	Valores válidos: PrePaid: assinatura PostPaid: pagamento conforme o uso
NetworkType	String	Não	Sim	Tipo de rede.	Valores válidos: Classic VPC
DBInstanceDescription	String	Não	Sim	Descrição da instância.	Nenhuma.
Tags	List	Não	Sim	Tags da instância.	Máximo de 20 tags. Propriedades de Tags.
RefreshOptions	String	Não	Sim	Política de atualização dos recursos da source de dados durante a atualização da pilha.	Valores válidos: Never (padrão): não atualiza os recursos da source de dados durante a atualização da pilha. Always: atualiza os recursos da source de dados durante a atualização da pilha.

Sintaxe de Tags

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Propriedades de Tags

Propriedade	Tipo	Obrigatória	Editável	Descrição	Restrição
Value	String	Não	Não	Valor da tag.	De 1 a 128 caracteres. Não pode começar com `aliyun`, `acs:`, `http://` ou `https://`.
Key	String	Sim	Não	Chave da tag.	De 1 a 128 caracteres. Não pode começar com `aliyun`, `acs:`, `http://` ou `https://`.

Valores de retorno (Fn::GetAtt)

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

Propriedade	Tipo	Descrição	Restrição
InstanceIds	List	IDs das instâncias.	Nenhuma.
Instances	List	Detalhes das instâncias.	Nenhuma.
ChargeType	String	Método de faturamento.	Valores válidos: PrePaid: assinatura PostPaid: pagamento conforme o uso
Tags	List	Tags da instância.	Nenhuma.
VpcAuthMode	String	Indica se o acesso sem senha via VPC está ativado.	Valores válidos: Open Close
NetworkType	String	Tipo de rede.	Valores válidos: Classic VPC
LockMode	String	Modo de bloqueio da instância.	Valores válidos: Unlock: não bloqueada. ManualLock: bloqueada manualmente. LockByExpiration: bloqueada automaticamente após expiração. LockByRestoration: bloqueada automaticamente antes da reversão. LockByDiskQuota: bloqueada automaticamente quando a capacidade do disco se esgota. Released: a instância foi liberada e não pode ser desbloqueada. Restaure apenas a partir de um backup.
EngineVersion	String	Versão do mecanismo de banco de dados.	Nenhuma.
MongosList	List	Detalhes dos nós mongos.	Retornado apenas quando DBInstanceType é sharding.
DBInstanceDescription	String	Descrição da instância.	Nenhuma.
DBInstanceType	String	Arquitetura da instância.	Valores válidos: sharding: instância de cluster fragmentado replicate: instância de conjunto de réplicas ou instância independente serverless: instância serverless
ShardList	List	Detalhes dos nós shard.	Retornado apenas quando DBInstanceType é sharding.
DBInstanceStatus	String	Status da instância.	Valores válidos: Estados da instância.
DBInstanceStorage	Number	Capacidade de armazenamento da instância.	Nenhuma.
ResourceGroupId	String	ID do grupo de recursos.	Nenhuma.
ZoneId	String	ID da zona.	Nenhuma.
DBInstanceId	String	ID da instância.	Nenhuma.
DBInstanceClass	String	Especificação da instância.	Valores válidos: Especificações de instância.
Engine	String	Mecanismo de banco de dados.	Nenhuma.
ReplicationFactor	String	Número de nós na instância.	Retornado apenas quando DBInstanceType é replicate.
KindCode	String	Código de tipo da instância.	Valores válidos: 0: máquina física 1: instância do Elastic Compute Service (ECS) 2: cluster Docker 18: cluster Kubernetes
CapacityUnit	String	Throughput de leitura e gravação consumido pela instância.	Retornado apenas quando DBInstanceType é serverless.

Exemplos

Formato JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "Type": "String",
      "Description": "The zone ID of the instance. You can call the DescribeRegions operation to query the most recent zone list. ",
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId"
    },
    "DbType": {
      "Type": "String",
      "Description": "The database engine type of the instance.\nnormal: replica set instance\nsharding: sharded cluster instance",
      "Default": "normal"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::MONGODB::InstanceClasses",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "DbType": {
          "Ref": "DbType"
        }
      }
    }
  },
  "Outputs": {
    "InstanceClasses": {
      "Description": "The list of The instance classes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClasses"
        ]
      }
    },
    "InstanceClassIds": {
      "Description": "The list of The instance class Ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClassIds"
        ]
      }
    }
  }
}