全部产品
Search
文档中心

Resource Orchestration Service:ALIYUN::RDS::ReadOnlyDBInstance

更新时间:Jul 06, 2025

ALIYUN::RDS::ReadOnlyDBInstance digunakan untuk membuat instance ApsaraDB RDS yang hanya dapat dibaca.

Sintaksis

{
  "Type": "ALIYUN::RDS::ReadOnlyDBInstance",
  "Properties": {
    "Category": String,
    "VPCId": String,
    "DBInstanceDescription": String,
    "Tags": Map,
    "EngineVersion": String,
    "DBInstanceId": String,
    "PayType": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "DBInstanceStorage": Integer,
    "VSwitchId": String,
    "DBInstanceStorageType": String,
    "DBInstanceClass": String,
    "PrivateIpAddress": String,
    "PeriodType": String,
    "Period": Integer,
    "AutoRenew": Boolean,
    "TargetDedicatedHostIdForMaster": String,
    "DeletionProtection": Boolean,
    "DedicatedHostGroupId": String
  }
}

Properti

Properti

Tipe

Diperlukan

Dapat Diedit

Deskripsi

Batasan

Kategori

String

Tidak

Tidak

Edition instance.

Nilai valid:

  • Basic: Basic Edition.

  • HighAvailability (default): High-availability Edition

  • AlwaysOn: Cluster Edition

VPCId

String

Tidak

Tidak

ID virtual private cloud (VPC) dari instance yang hanya bisa dibaca.

Tidak ada.

DBInstanceDescription

String

Tidak

Tidak

Deskripsi instance.

Deskripsi instance harus memiliki panjang 2 hingga 256 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Deskripsi harus dimulai dengan huruf tetapi tidak boleh dimulai dengan http:// atau https://.

Tags

Map

Tidak

Ya

Tag instance yang hanya bisa dibaca.

Tag dalam format pasangan kunci-nilai. Contoh:

{"key1": "value1","key2": "value2", ... "key5": "value5"}

Anda dapat menentukan hingga lima pasangan kunci-nilai. Kunci tag dapat memiliki panjang hingga 64 karakter dan tidak boleh dimulai dengan http:// atau https://. Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh dimulai dengan aliyun, http://, atau https://.

EngineVersion

String

Ya

Tidak

Versi mesin database.

Versi mesin database instance yang hanya bisa dibaca harus sama dengan versi mesin database instance utama.

  • Nilai valid ketika mesin database adalah MySQL:

    • 5.6

    • 5.7

    • 8.0

  • Nilai valid ketika mesin database adalah SQL Server: 2017_ent

DBInstanceId

String

Ya

Tidak

ID instance utama.

Tidak ada.

PayType

String

Tidak

Tidak

Metode penagihan instance yang hanya bisa dibaca.

Hanya metode penagihan bayar sesuai pemakaian yang didukung.

Atur nilainya menjadi Postpaid.

ZoneId

String

Ya

Tidak

ID zona instance yang hanya bisa dibaca.

Anda dapat memanggil operasi DescribeRegions untuk menanyakan daftar zona terbaru.

ResourceGroupId

String

Tidak

Tidak

ID grup sumber daya.

Tidak ada.

DBInstanceStorage

Integer

Ya

Ya

Kapasitas penyimpanan instance yang hanya bisa dibaca.

Satuan: GB.

Nilai valid: 5 hingga 3000. Nilai harus merupakan kelipatan dari 5.

Instance dari versi berbeda memiliki rentang nilai yang berbeda. Untuk informasi lebih lanjut, lihat Tipe Instance Utama ApsaraDB RDS.

VSwitchId

String

Tidak

Tidak

ID vSwitch instance yang hanya bisa dibaca.

Tidak ada.

DBInstanceStorageType

String

Tidak

Tidak

Tipe penyimpanan instance yang hanya bisa dibaca.

Nilai valid:

  • local_ssd atau ephemeral_ssd: SSD lokal

  • cloud_ssd: SSD standar

  • cloud_essd: Enhanced SSD (ESSD)

Catatan

Anda hanya dapat menggunakan SSD lokal untuk instance ApsaraDB RDS for MySQL yang hanya bisa dibaca, dan hanya dapat menggunakan SSD standar atau ESSD untuk instance ApsaraDB RDS for SQL Server yang hanya bisa dibaca.

DBInstanceClass

String

Ya

Ya

Tipe instance dari instance yang hanya bisa dibaca.

Untuk informasi lebih lanjut, lihat Tipe Instance Utama ApsaraDB RDS.

Kami merekomendasikan Anda menentukan tipe instance yang lebih tinggi atau sama dengan tipe instance utama. Jika tipe instance dari instance yang hanya bisa dibaca lebih rendah daripada tipe instance utama, instance yang hanya bisa dibaca mungkin mengalami masalah seperti latensi tinggi dan beban berat.

PrivateIpAddress

String

Tidak

Tidak

Alamat IP privat instance yang hanya bisa dibaca.

Alamat IP privat harus berada dalam rentang alamat IP vSwitch yang Anda tentukan. Sistem secara otomatis menetapkan alamat IP privat ke instance berdasarkan nilai VPCId dan VSwitchId.

PeriodType

String

Tidak

Tidak

Satuan durasi langganan instance yang hanya bisa dibaca.

Nilai valid:

  • Tahun

  • Bulan

Period

Integer

Tidak

Tidak

Durasi langganan instance yang hanya bisa dibaca.

  • Nilai valid ketika PeriodType diatur ke Tahun: 1 hingga 3.

  • Nilai valid ketika PeriodType diatur ke Bulan: 1 hingga 9.

AutoRenew

Boolean

Tidak

Tidak

Menentukan apakah akan mengaktifkan perpanjangan otomatis untuk instance yang hanya bisa dibaca.

Properti ini berlaku hanya ketika instance yang hanya bisa dibaca menggunakan metode penagihan langganan.

Nilai valid:

  • true

  • false (default)

Catatan
  • Jika Anda mengatur PeriodType ke Bulan, siklus perpanjangan otomatis adalah satu bulan.

  • Jika Anda mengatur PeriodType ke Tahun, siklus perpanjangan otomatis adalah satu tahun.

TargetDedicatedHostIdForMaster

String

Tidak

Tidak

ID host tempat instance utama berada. Properti ini berlaku ketika Anda membuat instance yang hanya bisa dibaca di klaster khusus.

Tidak ada.

DeletionProtection

Boolean

Tidak

Tidak

Menentukan apakah akan mengaktifkan fitur perlindungan pelepasan untuk instance yang hanya bisa dibaca.

Nilai valid:

  • true:

  • false (default)

Catatan

Anda dapat mengaktifkan fitur perlindungan pelepasan untuk instance yang ditagih berdasarkan metode bayar sesuai pemakaian.

DedicatedHostGroupId

String

Tidak

Tidak

ID klaster khusus tempat instance yang hanya bisa dibaca milik. Properti ini valid ketika Anda membuat instance yang hanya bisa dibaca di klaster khusus.

Tidak ada.

Nilai pengembalian

Fn::GetAtt

  • ConnectionString: Titik akhir internal instance yang hanya dapat dibaca.

  • DBInstanceId: ID instance yang hanya dapat dibaca.

  • Port: Port internal instance yang hanya dapat dibaca.

Contoh

YAML Format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: ID instance utama.
  ZoneId:
    Type: String
    Description: Buat Availability Zone untuk instance untuk memastikan bahwa Availability Zone mendukung pembuatan spesifikasi sumber daya rds.
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    Label: Zone ID
  VPC:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description: Silakan cari ID yang dimulai dengan (vpc-xxx) dari console-Virtual Private Cloud
    Label: Existing VPC Instance ID
  VSwitch:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Description: Silakan cari ID VSwitch bisnis yang dimulai dengan(vsw-xxx) dari console-Virtual Private Cloud-VSwitches
    Label: Existing VSwitch ID
    AssociationPropertyMetadata:
      VpcId: VPC
      ZoneId: ZoneId
  EngineVersion:
    Type: String
    Description: 'MySQL: 5.5, 5.6, 5.7, 5.8, SQLServer: 2008r2, PostgreSQL: 9.4'
    Default: '5.6'
  DBInstanceClass:
    Type: String
    Description: Instance Class
    Default: rds.mysql.s2.large
  DBInstanceStorage:
    Type: Number
    Description: MySQL: 5-1000, SQLServer: 10-1000, lainnya: 5-2000
    Default: 40
Resources:
  ReadOnlyDBInstance:
    Type: ALIYUN::RDS::ReadOnlyDBInstance
    DependsOn: RDSInstance
    Properties:
      VPCId:
        Ref: VPC
      DBInstanceId:
        Ref: DBInstanceId
      ZoneId:
        Ref: ZoneId
      DBInstanceStorage:
        Ref: DBInstanceStorage
      VSwitchId:
        Ref: VSwitch
      EngineVersion:
        Ref: EngineVersion
      DBInstanceClass:
        Ref: DBInstanceClass
Outputs:
  DBInstanceId:
    Description: The instance id of created database instance.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - DBInstanceId
  Port:
    Description: Intranet port of created DB instance.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - Port
  ConnectionString:
    Description: DB instance connection url by Intranet.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - ConnectionString

JSON Format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "ID instance utama."
    },
    "ZoneId": {
      "Type": "String",
      "Description": "Buat Availability Zone untuk instance untuk memastikan bahwa Availability Zone mendukung pembuatan spesifikasi sumber daya rds.",
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "Label": "Zone ID"
    },
    "VPC": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": "Silakan cari ID yang dimulai dengan (vpc-xxx) dari console-Virtual Private Cloud",
      "Label": "Existing VPC Instance ID"
    },
    "VSwitch": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Description": "Silakan cari ID VSwitch bisnis yang dimulai dengan(vsw-xxx) dari console-Virtual Private Cloud-VSwitches",
      "Label": "Existing VSwitch ID",
      "AssociationPropertyMetadata": {
        "VpcId": "VPC",
        "ZoneId": "ZoneId"
      }
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "MySQL: 5.5, 5.6, 5.7, 5.8, SQLServer: 2008r2, PostgreSQL: 9.4",
      "Default": "5.6"
    },
    "DBInstanceClass": {
      "Type": "String",
      "Description": "Instance Class",
      "Default": "rds.mysql.s2.large"
    },
    "DBInstanceStorage": {
      "Type": "Number",
      "Description": "MySQL:5-1000, SQLServer: 10-1000, lainnya: 5-2000",
      "Default": 40
    }
  },
  "Resources": {
    "ReadOnlyDBInstance": {
      "Type": "ALIYUN::RDS::ReadOnlyDBInstance",
      "DependsOn": "RDSInstance",
      "Properties": {
        "VPCId": {
          "Ref": "VPC"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "DBInstanceStorage": {
          "Ref": "DBInstanceStorage"
        },
        "VSwitchId": {
          "Ref": "VSwitch"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "DBInstanceClass": {
          "Ref": "DBInstanceClass"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceId": {
      "Description": "The instance id of created database instance.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "DBInstanceId"
        ]
      }
    },
    "Port": {
      "Description": "Intranet port of created DB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "Port"
        ]
      }
    },
    "ConnectionString": {
      "Description": "DB instance connection url by Intranet.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "ConnectionString"
        ]
      }
    }
  }
}