全部产品
Search
文档中心

Resource Orchestration Service:ALIYUN::DMS::Instance

更新时间:Jun 26, 2025

ALIYUN::DMS::Instance digunakan untuk mendaftarkan instance database perusahaan Anda.

Sintaksis

{
  "Type": "ALIYUN::DMS::Instance",
  "Properties": {
    "InstanceSource": String,
    "DatabasePassword": String,
    "Port": Integer,
    "Host": String,
    "ExportTimeout": Integer,
    "SafeRule": String,
    "DdlOnline": Integer,
    "EnvType": String,
    "Tid": Integer,
    "UseDsql": Integer,
    "Sid": String,
    "EcsInstanceId": String,
    "VpcId": String,
    "InstanceAlias": String,
    "DbaUid": Integer,
    "EcsRegion": String,
    "NetworkType": String,
    "DatabaseUser": String,
    "InstanceType": String,
    "DataLinkName": String,
    "QueryTimeout": Integer
  }
}

Properti

Properti

Tipe

Diperlukan

Dapat Diedit

Deskripsi

Kendala

InstanceSource

String

Ya

Tidak

Sumber dari instance database.

Nilai yang valid:

  • PUBLIC_OWN: instance database mandiri yang ditempatkan di Internet

  • RDS: instance ApsaraDB RDS

  • ECS_OWN: database mandiri yang ditempatkan pada instance Elastic Compute Service (ECS)

  • VPC_IDC: instance database mandiri yang ditempatkan di pusat data yang terhubung melalui virtual private cloud (VPC)

DatabasePassword

String

Ya

Ya

Kata sandi yang digunakan untuk menghubungkan ke instance database.

Tidak ada.

Port

Integer

Ya

Tidak

Nomor port yang digunakan untuk menghubungkan ke instance database.

Tidak ada.

Host

String

Ya

Tidak

Alamat host yang digunakan untuk menghubungkan ke instance database.

Tidak ada.

ExportTimeout

Integer

Ya

Ya

Jangka waktu timeout untuk mengekspor data.

Satuan: detik.

SafeRule

String

Ya

Ya

Nama aturan keamanan untuk instance database. Tentukan nama aturan keamanan yang dimiliki oleh perusahaan Anda.

Tidak ada.

DdlOnline

Integer

Tidak

Tidak

Menentukan apakah akan menggunakan fitur perubahan skema tanpa kunci.

Nilai yang valid:

  • 0: menonaktifkan fitur perubahan skema tanpa kunci.

  • 1: menggunakan operasi DDL online asli MySQL terlebih dahulu.

  • 2: menggunakan fitur perubahan skema tanpa kunci dari Data Management (DMS) terlebih dahulu.

Catatan

Hanya mendukung database MySQL dan PolarDB.

EnvType

String

Ya

Ya

Tipe lingkungan.

Nilai yang valid:

  • product: lingkungan produksi

  • dev: lingkungan pengembangan

  • pre: lingkungan pra-rilis

  • test: Lingkungan pengujian

  • sit: lingkungan pengujian integrasi sistem (SIT)

  • uat: lingkungan pengujian penerimaan pengguna (UAT)

  • pet: lingkungan uji stres

  • stag: lingkungan staging

Tid

Integer

Tidak

Tidak

ID penyewa.

Tidak ada.

UseDsql

Integer

Tidak

Tidak

Menentukan apakah akan mengaktifkan fitur query lintas database untuk instance database.

Nilai yang valid:

  • 0: menonaktifkan fitur query lintas database untuk instance database.

  • 1: mengaktifkan fitur query lintas database untuk instance database.

Sid

String

Tidak

Tidak

ID sistem (SID) dari instance database.

Properti ini harus ditentukan ketika InstanceType diatur ke PostgreSQL atau Oracle.

EcsInstanceId

String

Tidak

Tidak

ID instance ECS.

Properti ini harus ditentukan ketika InstanceSource diatur ke ECS_OWN.

VpcId

String

Tidak

Tidak

ID VPC.

Properti ini harus ditentukan ketika InstanceSource diatur ke VPC_IDC.

InstanceAlias

String

Ya

Ya

Nama instance database.

Tidak ada.

DbaUid

Integer

Ya

Tidak

ID pengguna akun Alibaba Cloud tempat instance database berada.

Tidak ada.

EcsRegion

String

Tidak

Tidak

ID wilayah instance database.

Properti ini harus ditentukan ketika InstanceSource diatur ke RDS, ECS_OWN, atau VPC_IDC.

NetworkType

String

Ya

Tidak

Tipe jaringan.

Nilai yang valid:

  • CLASSIC

  • VPC

DatabaseUser

String

Ya

Ya

Akun yang digunakan untuk menghubungkan ke instance database.

Tidak ada.

InstanceType

String

Ya

Tidak

Tipe instance database.

Nilai yang valid:

  • MySQL

  • SQLServer

  • PostgreSQL

  • Oracle

  • DRDS

  • OceanBase

  • Mongo

  • Redis

DataLinkName

String

Tidak

Tidak

Nama tautan database untuk query lintas database.

Tidak ada.

QueryTimeout

Integer

Ya

Ya

Jangka waktu timeout untuk menanyakan data.

Satuan: detik.

Nilai Pengembalian

Fn::GetAtt

  • InstanceId: ID instance database.

  • Port: Nomor port yang digunakan untuk menghubungkan ke instance database.

  • Host: Alamat host yang digunakan untuk menghubungkan ke instance database.

Contoh

Format YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceSource:
    Type: String
    Description: >-
      Sumber dari instance database. Nilai yang valid:
      PUBLIC_OWN: database on-premise yang dibangun di jaringan publik.
      RDS: sebuah instance ApsaraDB for RDS (RDS).
      ECS_OWN: database on-premise yang dibangun di instance Elastic Compute Service (ECS).
      VPC_IDC: database on-premise yang dibangun di pusat data internet (IDC) dalam Virtual Private
      Cloud (VPC).
  DatabasePassword:
    Type: String
    Description: Kata sandi logon dari instance database.
  Port:
    Type: Number
    Description: Port koneksi dari instance database.
  Host:
    Type: String
    Description: Titik akhir dari instance database.
  ExportTimeout:
    Type: Number
    Description: 'Jangka waktu timeout untuk mengekspor instance database. Satuan: detik.'
  SafeRule:
    Type: String
    Description: >-
      Aturan keamanan dari instance database. Masukkan nama aturan keamanan untuk
      perusahaan Anda.
      Catatan Untuk memeriksa aturan keamanan tertentu, masuk ke konsol DMS Enterprise dan pilih
      Manajemen Sistem > Aturan Keamanan. Aturan keamanan muncul dalam daftar aturan keamanan.
  DdlOnline:
    Type: Number
    Description: >-
      [Penting] Menentukan apakah akan mengaktifkan layanan bahasa deskripsi data online (DDL)

      Saat ini, layanan ini hanya tersedia untuk database MySQL dan PolarDB.
      0: Layanan dinonaktifkan.
      1: Layanan DDL online asli lebih diutamakan.
      2: Perubahan data tanpa penguncian tabel yang disediakan oleh DMS lebih diutamakan.
  EnvType:
    Type: String
    Description: >-
      Tipe lingkungan tempat instance database berada. Nilai yang valid:
      product: lingkungan produksi.
      dev: lingkungan pengujian.
  Tid:
    Type: Number
    Description: >-
      ID penyewa.
      Catatan Untuk memeriksa ID, masuk ke konsol DMS Enterprise dan pilih Manajemen Sistem
      > Manajemen Instance atau Manajemen Sistem > Manajemen Pengguna. ID penyewa muncul di bagian Spesifikasi Layanan.
  UseDsql:
    Type: Number
    Description: >-
      Menentukan apakah akan mengaktifkan query lintas database untuk instance database. Nilai yang valid:
      0: dinonaktifkan
      1: diaktifkan
    AllowedValues:
      - 0
      - 1
  Sid:
    Type: String
    Description: >-
      ID sistem (SID) dari instance database.
      Catatan Anda harus menentukan parameter ini jika parameter InstanceType diatur ke PostgreSQL atau Oracle.
  EcsInstanceId:
    Type: String
    Description: >-
      ID instance ECS tempat instance database berada.
      Catatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur ke ECS_OWN.
  VpcId:
    Type: String
    Description: >-
      ID VPC tempat instance database berada.
      Catatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur ke VPC_IDC.
  DbaUid:
    Type: Number
    Description: >-
      ID unik Alibaba Cloud (UID) dari administrator database (DBA) dari instance database.
      Catatan Untuk memeriksa UID, masuk ke konsol DMS Enterprise dan pilih Manajemen Sistem
      > Manajemen Pengguna.
  EcsRegion:
    Type: String
    Description: >-
      Wilayah tempat instance database berada.
      Catatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur ke ECS_OWN atau VPC_IDC.
  NetworkType:
    Type: String
    Description: |-
      Tipe jaringan dari instance database. Nilai yang valid:
      CLASSIC
      VPC
    AllowedValues:
      - CLASSIC
      - VPC
  InstanceAlias:
    Type: String
    Description: >-
      Alias dari instance database. Alias membantu Anda dengan cepat menemukan
      instance yang diperlukan.
  DatabaseUser:
    Type: String
    Description: Nama pengguna logon dari instance database.
  InstanceType:
    Type: String
    Description: >-
      Tipe dari instance database. Nilai yang valid: MySQL, SQLServer,
      PostgreSQL, Oracle, DRDS, OceanBase, Mongo, Redis
    AllowedValues:
      - MySQL
      - SQLServer
      - PostgreSQL
      - Oracle
      - DRDS
      - OceanBase
      - Mongo
      - Redis
  DataLinkName:
    Type: String
    Description: Nama tautan data untuk query lintas database.
  QueryTimeout:
    Type: Number
    Description: 'Jangka waktu timeout untuk menanyakan instance database. Satuan: detik.'
Resources:
  Instance:
    Type: 'ALIYUN::DMS::Instance'
    Properties:
      InstanceSource:
        Ref: InstanceSource
      DatabasePassword:
        Ref: DatabasePassword
      Port:
        Ref: Port
      Host:
        Ref: Host
      ExportTimeout:
        Ref: ExportTimeout
      SafeRule:
        Ref: SafeRule
      DdlOnline:
        Ref: DdlOnline
      EnvType:
        Ref: EnvType
      Tid:
        Ref: Tid
      UseDsql:
        Ref: UseDsql
      Sid:
        Ref: Sid
      EcsInstanceId:
        Ref: EcsInstanceId
      VpcId:
        Ref: VpcId
      DbaUid:
        Ref: DbaUid
      EcsRegion:
        Ref: EcsRegion
      NetworkType:
        Ref: NetworkType
      InstanceAlias:
        Ref: InstanceAlias
      DatabaseUser:
        Ref: DatabaseUser
      InstanceType:
        Ref: InstanceType
      DataLinkName:
        Ref: DataLinkName
      QueryTimeout:
        Ref: QueryTimeout
Outputs:
  InstanceId:
    Description: ID dari instance database.
    Value:
      'Fn::GetAtt':
        - Instance
        - InstanceId
  Port:
    Description: Port koneksi dari instance database.
    Value:
      'Fn::GetAtt':
        - Instance
        - Port
  Host:
    Description: Titik akhir dari instance database.
    Value:
      'Fn::GetAtt':
        - Instance
        - Host

Format JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceSource": {
      "Type": "String",
      "Description": "Sumber dari instance database. Nilai yang valid:\nPUBLIC_OWN: database on-premise yang dibangun di jaringan publik.\nRDS: sebuah instance ApsaraDB for RDS (RDS).\nECS_OWN: database on-premise yang dibangun di instance Elastic Compute Service (ECS).\nVPC_IDC: database on-premise yang dibangun di pusat data internet (IDC) dalam Virtual Private\nCloud (VPC)."
    },
    "DatabasePassword": {
      "Type": "String",
      "Description": "Kata sandi logon dari instance database."
    },
    "Port": {
      "Type": "Number",
      "Description": "Port koneksi dari instance database."
    },
    "Host": {
      "Type": "String",
      "Description": "Titik akhir dari instance database."
    },
    "ExportTimeout": {
      "Type": "Number",
      "Description": "Jangka waktu timeout untuk mengekspor instance database. Satuan: detik."
    },
    "SafeRule": {
      "Type": "String",
      "Description": "Aturan keamanan dari instance database. Masukkan nama aturan keamanan untuk\nperusahaan Anda.\nCatatan Untuk memeriksa aturan keamanan tertentu, masuk ke konsol DMS Enterprise dan pilih\nManajemen Sistem > Aturan Keamanan. Aturan keamanan muncul dalam daftar aturan keamanan."
    },
    "DdlOnline": {
      "Type": "Number",
      "Description": "[Penting] Menentukan apakah akan mengaktifkan layanan bahasa deskripsi data online (DDL)\nlayanannya. Saat ini, layanan ini hanya tersedia untuk database MySQL dan PolarDB.\n0: Layanan dinonaktifkan.\n1: Layanan DDL online asli lebih diutamakan.\n2: Perubahan data tanpa penguncian tabel yang disediakan oleh DMS lebih diutamakan."
    },
    "EnvType": {
      "Type": "String",
      "Description": "Tipe lingkungan tempat instance database berada. Nilai yang valid:\nproduct: lingkungan produksi.\ndev: lingkungan pengujian."
    },
    "Tid": {
      "Type": "Number",
      "Description": "ID penyewa.\nCatatan Untuk memeriksa ID, masuk ke konsol DMS Enterprise dan pilih Manajemen Sistem\n> Manajemen Instance atau Manajemen Sistem > Manajemen Pengguna. ID penyewa muncul di bagian Spesifikasi Layanan."
    },
    "UseDsql": {
      "Type": "Number",
      "Description": "Menentukan apakah akan mengaktifkan query lintas database untuk instance database. Nilai yang valid:\n0: dinonaktifkan\n1: diaktifkan",
      "AllowedValues": [
        0,
        1
      ]
    },
    "Sid": {
      "Type": "String",
      "Description": "ID sistem (SID) dari instance database.\nCatatan Anda harus menentukan parameter ini jika parameter InstanceType diatur ke PostgreSQL atau Oracle."
    },
    "EcsInstanceId": {
      "Type": "String",
      "Description": "ID instance ECS tempat instance database berada.\nCatatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur ke ECS_OWN."
    },
    "VpcId": {
      "Type": "String",
      "Description": "ID VPC tempat instance database berada.\nCatatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur ke VPC_IDC."
    },
    "DbaUid": {
      "Type": "Number",
      "Description": "ID unik Alibaba Cloud (UID) dari administrator database (DBA) dari instance database.\nCatatan Untuk memeriksa UID, masuk ke konsol DMS Enterprise dan pilih Manajemen Sistem\n> Manajemen Pengguna."
    },
    "EcsRegion": {
      "Type": "String",
      "Description": "Wilayah tempat instance database berada.\nCatatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur ke ECS_OWN atau VPC_IDC."
    },
    "NetworkType": {
      "Type": "String",
      "Description": "Tipe jaringan dari instance database. Nilai yang valid:\nCLASSIC\nVPC",
      "AllowedValues": [
        "CLASSIC",
        "VPC"
      ]
    },
    "InstanceAlias": {
      "Type": "String",
      "Description": "Alias dari instance database. Alias membantu Anda dengan cepat menemukan instance yang diperlukan."
    },
    "DatabaseUser": {
      "Type": "String",
      "Description": "Nama pengguna logon dari instance database."
    },
    "InstanceType": {
      "Type": "String",
      "Description": "Tipe dari instance database. Nilai yang valid: MySQL, SQLServer, PostgreSQL, Oracle, DRDS, OceanBase, Mongo, Redis",
      "AllowedValues": [
        "MySQL",
        "SQLServer",
        "PostgreSQL",
        "Oracle",
        "DRDS",
        "OceanBase",
        "Mongo",
        "Redis"
      ]
    },
    "DataLinkName": {
      "Type": "String",
      "Description": "Nama tautan data untuk query lintas database."
    },
    "QueryTimeout": {
      "Type": "Number",
      "Description": "Jangka waktu timeout untuk menanyakan instance database. Satuan: detik."
    }
  },
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::DMS::Instance",
      "Properties": {
        "InstanceSource": {
          "Ref": "InstanceSource"
        },
        "DatabasePassword": {
          "Ref": "DatabasePassword"
        },
        "Port": {
          "Ref": "Port"
        },
        "Host": {
          "Ref": "Host"
        },
        "ExportTimeout": {
          "Ref": "ExportTimeout"
        },
        "SafeRule": {
          "Ref": "SafeRule"
        },
        "DdlOnline": {
          "Ref": "DdlOnline"
        },
        "EnvType": {
          "Ref": "EnvType"
        },
        "Tid": {
          "Ref": "Tid"
        },
        "UseDsql": {
          "Ref": "UseDsql"
        },
        "Sid": {
          "Ref": "Sid"
        },
        "EcsInstanceId": {
          "Ref": "EcsInstanceId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "DbaUid": {
          "Ref": "DbaUid"
        },
        "EcsRegion": {
          "Ref": "EcsRegion"
        },
        "NetworkType": {
          "Ref": "NetworkType"
        },
        "InstanceAlias": {
          "Ref": "InstanceAlias"
        },
        "DatabaseUser": {
          "Ref": "DatabaseUser"
        },
        "InstanceType": {
          "Ref": "InstanceType"
        },
        "DataLinkName": {
          "Ref": "DataLinkName"
        },
        "QueryTimeout": {
          "Ref": "QueryTimeout"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "ID dari instance database.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "Port": {
      "Description": "Port koneksi dari instance database.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Port"
        ]
      }
    },
    "Host": {
      "Description": "Titik akhir dari instance database.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Host"
        ]
      }
    }
  }
}