全部产品
Search
文档中心

Resource Orchestration Service:DATASOURCE::RDS::DBInstances

更新时间:Jun 26, 2025

DATASOURCE::RDS::DBInstances digunakan untuk menanyakan instans ApsaraDB RDS.

Sintaksis

{
  "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
  }
}

Properti

Properti

Tipe

Diperlukan

Dapat Diedit

Deskripsi

Batasan

DedicatedHostId

String

Tidak

Ya

ID host di klaster khusus.

Tidak ada.

EngineVersion

String

Tidak

Ya

Versi mesin database.

Tidak ada.

DBInstanceStatus

String

Tidak

Ya

Status instans.

Untuk informasi lebih lanjut, lihat Tabel status instans.

ResourceGroupId

String

Tidak

Ya

ID grup sumber daya.

Tidak ada.

ZoneId

String

Tidak

Ya

ID zona.

Tidak ada.

DBInstanceClass

String

Tidak

Ya

Tipe instans.

Untuk informasi lebih lanjut, lihat Tipe instans utama ApsaraDB RDS.

DedicatedHostGroupId

String

Tidak

Ya

ID klaster khusus.

Tidak ada.

VSwitchId

String

Tidak

Ya

ID vSwitch.

Tidak ada.

DBInstanceType

String

Tidak

Ya

Kategori instans.

Nilai valid:

  • Primary: instans utama

  • Readonly: instans baca-saja

  • Guard: instans pemulihan bencana

  • Temp: instans sementara

InstanceLevel

Number

Tidak

Ya

Menentukan apakah akan mengembalikan edisi instans.

Nilai valid:

  • 0: tidak mengembalikan edisi instans.

  • 1: mengembalikan edisi instans.

Expired

String

Tidak

Ya

Menentukan apakah instans telah kedaluwarsa.

Nilai valid:

  • true

  • false

PayType

String

Tidak

Ya

Metode penagihan.

Nilai valid:

  • Postpaid: bayar sesuai pemakaian

  • Prepaid: langganan

InstanceNetworkType

String

Tidak

Ya

Tipe jaringan instans.

Nilai valid:

  • VPC

  • Classic

VpcId

String

Tidak

Ya

ID virtual private cloud (VPC).

Tidak ada.

DBInstanceId

String

Tidak

Ya

ID instans.

Tidak ada.

SearchKey

String

Tidak

Ya

Kata kunci ID instans atau deskripsi, yang digunakan untuk melakukan pencarian fuzzy pada instans.

Tidak ada.

ConnectionMode

String

Tidak

Ya

Mode koneksi instans.

Nilai valid:

  • Standard: mode standar

  • Safe: mode proksi database

ConnectionString

String

Tidak

Ya

Titik akhir instans.

Tidak ada.

Engine

String

Tidak

Ya

Tipe mesin database.

Nilai valid:

  • MySQL

  • SQLServer

  • PostgreSQL

  • MariaDB

proxyId

String

Tidak

Ya

ID mode proksi.

Tidak ada.

RefreshOptions

String

Tidak

Ya

Kebijakan refresh untuk sumber daya data saat tumpukan diperbarui.

Nilai valid:

  • Never (default): tidak merefresh sumber daya data saat tumpukan diperbarui.

  • Always: merefresh sumber daya data saat tumpukan diperbarui.

Nilai pengembalian (Fn::GetAtt)

  • DBInstanceIds: ID instans.

  • DBInstances: detail instans.

Properti

Tipe

Deskripsi

Batasan

DBInstanceIds

List

ID instans.

Tidak ada.

DBInstances

List

Detail instans.

Tidak ada.

VpcId

String

ID VPC.

Tidak ada.

CreateTime

String

Waktu pembuatan.

Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

PayType

String

Metode penagihan instans.

Nilai valid:

  • Postpaid: bayar sesuai pemakaian

  • Prepaid: langganan

EngineVersion

String

Versi mesin database.

Tidak ada.

VpcName

String

Nama VPC.

Tidak ada.

ConnectionString

String

Titik akhir instans.

Tidak ada.

InstanceNetworkType

String

Tipe jaringan instans.

Nilai valid:

  • Classic

  • VPC

MasterInstanceId

String

ID instans utama.

Nilai null menunjukkan bahwa instans adalah instans utama.

ExpireTime

String

Waktu kedaluwarsa.

Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

Catatan

Properti ini tidak dikembalikan untuk instans bayar sesuai pemakaian.

GuardDBInstanceId

String

ID instans pemulihan bencana.

Tidak ada.

ZoneId

String

ID zona.

Tidak ada.

DBInstanceId

String

ID instans.

Tidak ada.

TempDBInstanceId

String

ID instans sementara.

Tidak ada.

DBInstanceStorageType

String

Tipe penyimpanan instans.

Tidak ada.

ConnectionMode

String

Mode koneksi instans.

Nilai valid:

  • Standard: mode standar

  • Safe: mode proksi database

DBInstanceDescription

String

Deskripsi instans.

Tidak ada.

DBInstanceNetType

String

Tipe koneksi jaringan instans.

Nilai valid:

  • Internet

  • Intranet

DBInstanceType

String

Kategori instans.

Nilai valid:

  • Primary: instans utama

  • Readonly: instans baca-saja

  • Guard: instans pemulihan bencana

  • Temp: instans sementara

DBInstanceStatus

String

Status instans.

Untuk informasi lebih lanjut, lihat Tabel status instans.

VSwitchId

String

ID vSwitch.

Tidak ada.

ResourceGroupId

String

ID grup sumber daya.

Tidak ada.

Category

String

Edisi instans.

Nilai valid:

  • Basic: RDS Basic Edition

  • HighAvailability: RDS High-availability Edition

  • Finance: RDS Enterprise Edition

Catatan

Properti ini dikembalikan jika InstanceLevel diatur ke 1.

Engine

String

Tipe mesin database.

Nilai valid:

  • MySQL

  • SQLServer

  • PostgreSQL

  • MariaDB

DBInstanceClass

String

Tipe instans.

Untuk informasi lebih lanjut, lihat Tipe instans utama ApsaraDB RDS.

ReadOnlyDBInstanceIds

List

ID instans baca-saja.

Tidak ada.

DeletionProtection

Boolean

Menunjukkan apakah fitur perlindungan pelepasan diaktifkan.

Nilai valid:

  • true

  • false

Contoh

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "ID instans."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::RDS::DBInstances",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DBInstances": {
      "Description": "Daftar instans Database RDS.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstances"
        ]
      }
    },
    "DBInstanceIds": {
      "Description": "Daftar ID instans Database RDS.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceIds"
        ]
      }
    }
  }
}
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: ID instans.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::RDS::DBInstances
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
Outputs:
  DBInstances:
    Description: Daftar instans Database RDS.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstances
  DBInstanceIds:
    Description: Daftar ID instans Database RDS.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceIds