Todos os produtos
Search

Este produto

    Resource Orchestration Service:DATASOURCE::RDS::DBInstances

    Central de documentação

    Resource Orchestration Service:DATASOURCE::RDS::DBInstances

    Última atualização: Jun 27, 2026

    O tipo de recurso DATASOURCE::RDS::DBInstances consulta instâncias do ApsaraDB RDS.

    Sintaxe

    {
  "Type": "DATASOURCE::RDS::DBInstances",
  "Properties": {
    "DedicatedHostId": String,
    "EngineVersion": String,
    "DBInstanceStatus": String,
    "ResourceGroupId": String,
    "ZoneId": String,
    "DBInstanceClass": String,
    "DedicatedHostGroupId": String,
    "VSwitchId": String,
    "DBInstanceType": String,
    "InstanceLevel": Number,
    "Expired": String,
    "PayType": String,
    "InstanceNetworkType": String,
    "VpcId": String,
    "DBInstanceId": String,
    "SearchKey": String,
    "ConnectionMode": String,
    "ConnectionString": String,
    "Engine": String,
    "proxyId": String,
    "RefreshOptions": String
  }
}

    Propriedades

    Propriedade

    Tipo

    Obrigatória

    Editável

    Descrição

    Restrição

    DedicatedHostId

    String

    Não

    Sim

    ID do host no cluster dedicado.

    Nenhuma.

    EngineVersion

    String

    Não

    Sim

    Versão do mecanismo de banco de dados.

    Nenhuma.

    DBInstanceStatus

    String

    Não

    Sim

    Status da instância.

    Para mais informações, consulte a Tabela de estados da instância.

    ResourceGroupId

    String

    Não

    Sim

    ID do grupo de recursos.

    Nenhuma.

    ZoneId

    String

    Não

    Sim

    ID da zona.

    Nenhuma.

    DBInstanceClass

    String

    Não

    Sim

    Tipo da instância.

    Para mais informações, consulte Tipos de instância primária do ApsaraDB RDS.

    DedicatedHostGroupId

    String

    Não

    Sim

    ID do cluster dedicado.

    Nenhuma.

    VSwitchId

    String

    Não

    Sim

    ID do vSwitch.

    Nenhuma.

    DBInstanceType

    String

    Não

    Sim

    Categoria da instância.

    Valores válidos:

    • Primary: instância primária

    • Readonly: instância somente leitura

    • Guard: instância de recuperação de desastres

    • Temp: instância temporária

    InstanceLevel

    Number

    Não

    Sim

    Defina se a edição da instância deve ser retornada.

    Valores válidos:

    • 0: não retorna a edição da instância.

    • 1: retorna a edição da instância.

    Expired

    String

    Não

    Sim

    Indica se a instância expirou.

    Valores válidos:

    • true

    • false

    PayType

    String

    Não

    Sim

    Método de faturamento.

    Valores válidos:

    • Postpaid: pagamento conforme o uso

    • Prepaid: assinatura

    InstanceNetworkType

    String

    Não

    Sim

    Tipo de rede da instância.

    Valores válidos:

    • VPC

    • Classic

    VpcId

    String

    Não

    Sim

    ID da Virtual Private Cloud (VPC).

    Nenhuma.

    DBInstanceId

    String

    Não

    Sim

    ID da instância.

    Nenhuma.

    SearchKey

    String

    Não

    Sim

    Palavra-chave para IDs ou descrições de instâncias, usada em buscas aproximadas.

    Nenhuma.

    ConnectionMode

    String

    Não

    Sim

    Modo de conexão da instância.

    Valores válidos:

    • Standard: modo padrão

    • Safe: modo de proxy de banco de dados

    ConnectionString

    String

    Não

    Sim

    Endpoint da instância.

    Nenhuma.

    Engine

    String

    Não

    Sim

    Tipo do mecanismo de banco de dados.

    Valores válidos:

    • MySQL

    • SQLServer

    • PostgreSQL

    • MariaDB

    proxyId

    String

    Não

    Sim

    ID do modo de proxy.

    Nenhuma.

    RefreshOptions

    String

    Não

    Sim

    Política de atualização dos recursos de source de dados durante a atualização da pilha.

    Valores válidos:

    • Never (padrão): não atualiza os recursos de source de dados ao atualizar a pilha.

    • Always: atualiza os recursos de source de dados ao atualizar a pilha.

    Valores de retorno (Fn::GetAtt)

    • DBInstanceIds: IDs das instâncias.

    • DBInstances: detalhes das instâncias.

    Propriedade

    Tipo

    Descrição

    Restrição

    DBInstanceIds

    List

    IDs das instâncias.

    Nenhuma.

    DBInstances

    List

    Detalhes das instâncias.

    Nenhuma.

    VpcId

    String

    ID da VPC.

    Nenhuma.

    CreateTime

    String

    Hora de criação.

    O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC.

    PayType

    String

    Método de faturamento da instância.

    Valores válidos:

    • Postpaid: pagamento conforme o uso

    • Prepaid: assinatura

    EngineVersion

    String

    Versão do mecanismo de banco de dados.

    Nenhuma.

    VpcName

    String

    Nome da VPC.

    Nenhuma.

    ConnectionString

    String

    Endpoint da instância.

    Nenhuma.

    InstanceNetworkType

    String

    Tipo de rede da instância.

    Valores válidos:

    • Classic

    • VPC

    MasterInstanceId

    String

    ID da instância primária.

    Um valor nulo indica que a instância é primária.

    ExpireTime

    String

    Data de expiração.

    O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC.

    Nota

    Esta propriedade não é retornada para instâncias com pagamento conforme o uso.

    GuardDBInstanceId

    String

    ID da instância de recuperação de desastres.

    Nenhuma.

    ZoneId

    String

    ID da zona.

    Nenhuma.

    DBInstanceId

    String

    ID da instância.

    Nenhuma.

    TempDBInstanceId

    String

    ID da instância temporária.

    Nenhuma.

    DBInstanceStorageType

    String

    Tipo de armazenamento da instância.

    Nenhuma.

    ConnectionMode

    String

    Modo de conexão da instância.

    Valores válidos:

    • Standard: modo padrão

    • Safe: modo de proxy de banco de dados

    DBInstanceDescription

    String

    Descrição da instância.

    Nenhuma.

    DBInstanceNetType

    String

    Tipo de conexão de rede da instância.

    Valores válidos:

    • Internet

    • Intranet

    DBInstanceType

    String

    Categoria da instância.

    Valores válidos:

    • Primary: instância primária

    • Readonly: instância somente leitura

    • Guard: instância de recuperação de desastres

    • Temp: instância temporária

    DBInstanceStatus

    String

    Status da instância.

    Para mais informações, consulte a Tabela de estados da instância.

    VSwitchId

    String

    ID do vSwitch.

    Nenhuma.

    ResourceGroupId

    String

    ID do grupo de recursos.

    Nenhuma.

    Category

    String

    Edição da instância.

    Valores válidos:

    • Basic: RDS Basic Edition

    • HighAvailability: RDS High-availability Edition

    • Finance: RDS Enterprise Edition

    Nota

    Esta propriedade é retornada se InstanceLevel estiver definido como 1.

    Engine

    String

    Tipo do mecanismo de banco de dados.

    Valores válidos:

    • MySQL

    • SQLServer

    • PostgreSQL

    • MariaDB

    DBInstanceClass

    String

    Tipo da instância.

    Para mais informações, consulte Tipos de instância primária do ApsaraDB RDS.

    ReadOnlyDBInstanceIds

    List

    IDs das instâncias somente leitura.

    Nenhuma.

    DeletionProtection

    Boolean

    Indica se o recurso de proteção contra exclusão está ativado.

    Valores válidos:

    • true

    • false

    Exemplos

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "The ID of the instance."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::RDS::DBInstances",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DBInstances": {
      "Description": "The list of The RDS Database instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstances"
        ]
      }
    },
    "DBInstanceIds": {
      "Description": "The list of The RDS Database instance Ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceIds"
        ]
      }
    }
  }
}
    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: The ID of the instance.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::RDS::DBInstances
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
Outputs:
  DBInstances:
    Description: The list of The RDS Database instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstances
  DBInstanceIds:
    Description: The list of The RDS Database instance Ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceIds