ALIYUN::POLARDB::DBClusterEndpoint - Resource Orchestration Service

ALIYUN::POLARDB::DBClusterEndpoint digunakan untuk membuat titik akhir kustom untuk kluster PolarDB.

Sintaksis

{
  "Type": "ALIYUN::POLARDB::DBClusterEndpoint",
  "Properties": {
    "DBClusterId": String,
    "ReadWriteMode": String,
    "EndpointType": String,
    "AutoAddNewNodes": String,
    "Nodes": List,
    "EndpointConfig": Map
  }
}

Properti

Properti	Tipe	Diperlukan	Dapat Diedit	Deskripsi	Batasan
DBClusterId	String	Ya	Tidak	ID dari kluster.	Tidak ada.
ReadWriteMode	String	Tidak	Ya	Mode baca/tulis.	Nilai yang valid: ReadWrite ReadOnly (default)
EndpointType	String	Tidak	Tidak	Tipe titik akhir kluster.	Tetapkan nilai ke Custom.
AutoAddNewNodes	String	Tidak	Ya	Menentukan apakah akan secara otomatis mengaitkan node baru dengan titik akhir kluster.	Nilai yang valid: Aktifkan Nonaktifkan (default)
Nodes	List	Tidak	Ya	Node yang digunakan untuk memproses permintaan baca.	Contoh: `["pi-bpsg35x**", "pi-bp3ddh**"]`. Setidaknya dua node harus ditentukan untuk properti ini. Jika Anda tidak menentukan properti ini, semua node dalam kluster digunakan untuk memproses permintaan baca yang dikirim ke titik akhir.
EndpointConfig	Map	Tidak	Ya	Konfigurasi lanjutan dari titik akhir kluster.	Untuk informasi lebih lanjut, lihat Properti EndpointConfig.

Sintaksis EndpointConfig

"EndpointConfig": {
  "ConsistLevel": String,
  "ConsistTimeout": String,
  "LoadBalancePolicy": String,
  "ConnectionPersist": String,
  "DistributedTransaction": String,
  "EnableOverloadThrottle": String,
  "MasterAcceptReads": String,
  "ConsistTimeoutAction": String,
  "EnableHtapImci": String,
  "MaxParallelDegree": String
}

Properti EndpointConfig

Properti	Tipe	Diperlukan	Dapat Diedit	Deskripsi	Batasan
ConsistLevel	String	Tidak	Ya	Tingkat konsistensi.	Nilai yang valid: 0: konsistensi akhir Catatan Jika parameter ReadWriteMode diatur ke ReadOnly, tingkat konsistensi harus 0. 1 (default): konsistensi sesi
ConsistTimeout	String	Tidak	Ya	Waktu habis untuk Bacaan Konsistensi Global.	Tidak ada.
LoadBalancePolicy	String	Tidak	Ya	Kebijakan penyeimbangan beban.	Format: {"LoadBalancePolicy":"Value"}. Nilai yang valid: 0 (default): penyeimbangan beban berbasis koneksi 1: penyeimbangan beban berbasis permintaan aktif
ConnectionPersist	String	Tidak	Ya	Menentukan apakah akan mengaktifkan pool koneksi.	Format: {"ConnectionPersist":"Value"}. Nilai yang valid: off (default): menonaktifkan pool koneksi. Sesi: mengaktifkan pool koneksi tingkat sesi. Transaksi: mengaktifkan pool koneksi tingkat transaksi.
DistributedTransaction	String	Tidak	Ya	Menentukan apakah akan mengaktifkan pemecahan transaksi.	Format: {"DistributedTransaction":"Value"}. Nilai yang valid: on (default) off
EnableOverloadThrottle	String	Tidak	Ya	Menentukan apakah akan mengaktifkan perlindungan overload.	Format: {"EnableOverloadThrottle":"Value"}. Nilai yang valid: on off (default)
MasterAcceptReads	String	Tidak	Ya	Menentukan apakah node utama menerima pembacaan.	Format: {"MasterAcceptReads":"off"}. Nilai yang valid: on off (default)
ConsistTimeoutAction	String	Tidak	Ya	Kebijakan waktu habis untuk konsistensi global.	Nilai yang valid: 0 (default): mengirimkan permintaan ke node utama. 1: mengembalikan kesalahan SQL.
EnableHtapImci	String	Tidak	Ya	Menentukan apakah akan mengaktifkan distribusi permintaan otomatis antara node penyimpanan baris dan kolom.	Format: {"EnableHtapImci":"Value"}. Nilai yang valid: on off (default)
MaxParallelDegree	String	Tidak	Ya	Menentukan apakah akan mengaktifkan query paralel.	Format: {"MaxParallelDegree":"Value"}. Nilai yang valid: on off (default)

Nilai Pengembalian

Fn::GetAtt

DBEndpointId: ID titik akhir kluster.
ConnectionString: string koneksi kluster.
Addresses: alamat IP.

Contoh

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  DBClusterEndpoint:
    Type: ALIYUN::POLARDB::DBClusterEndpoint
    Properties:
      DBClusterId:
        Ref: DBClusterId
      ReadWriteMode:
        Ref: ReadWriteMode
      EndpointConfig:
        Ref: EndpointConfig
      AutoAddNewNodes:
        Ref: AutoAddNewNodes
      Nodes:
        Fn::Split:
        - ","
        - Ref: Nodes
      EndpointType:
        Ref: EndpointType
Parameters:
  DBClusterId:
    Type: String
    Description: ID dari kluster ApsaraDB for POLARDB tempat titik koneksi kustom akan dibuat.
  ReadWriteMode:
    Default: ReadOnly
    Type: String
    Description: 'Mode baca/tulis dari titik koneksi kluster. Nilai yang valid: ReadWrite: menerima dan meneruskan permintaan baca dan tulis (pemisahan baca-tulis otomatis). ReadOnly: menerima dan meneruskan hanya permintaan baca. Nilai default: ReadOnly.'
    AllowedValues:
    - ReadOnly
    - ReadWrite
  EndpointConfig:
    Type: Json
    Description: ''
  AutoAddNewNodes:
    Default: Disable
    Type: String
    Description: |-
      Menentukan apakah node yang baru ditambahkan secara otomatis ditambahkan ke titik koneksi ini.
      Nilai yang valid: Enable, Disable.
      Nilai default: Disable.
    AllowedValues:
    - Disable
    - Enable
  Nodes:
    MinLength: 2
    Type: CommaDelimitedList
    Description: |-
      Node yang akan ditambahkan ke titik koneksi ini untuk memproses permintaan baca dari titik koneksi ini. Tambahkan setidaknya dua node.
      Jika Anda tidak menentukan parameter ini, semua node kluster secara default ditambahkan ke titik koneksi ini.
  EndpointType:
    Default: Custom
    Type: String
    Description: Jenis titik koneksi kluster. Tetapkan parameter ini ke Custom.
Outputs:
  DBEndpointId:
    Description: ID titik akhir kluster DB. Contoh: pe-xxxxxxxx.
    Value:
      Fn::GetAtt:
      - DBClusterEndpoint
      - DBEndpointId
  ConnectionString:
    Description: String koneksi pertama dari titik akhir kluster db.
    Value:
      Fn::GetAtt:
      - DBClusterEndpoint
      - ConnectionString
  Addresses:
    Description: Item alamat dari titik akhir kluster db.
    Value:
      Fn::GetAtt:
      - DBClusterEndpoint
      - Addresses

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "DBClusterEndpoint": {
      "Type": "ALIYUN::POLARDB::DBClusterEndpoint",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "ReadWriteMode": {
          "Ref": "ReadWriteMode"
        },
        "EndpointConfig": {
          "Ref": "EndpointConfig"
        },
        "AutoAddNewNodes": {
          "Ref": "AutoAddNewNodes"
        },
        "Nodes": {
          "Fn::Split": [
            ",",
            {
              "Ref": "Nodes"
            }
          ]
        },
        "EndpointType": {
          "Ref": "EndpointType"
        }
      }
    }
  },
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": "ID dari kluster ApsaraDB for POLARDB tempat titik koneksi kustom akan dibuat."
    },
    "ReadWriteMode": {
      "Default": "ReadOnly",
      "Type": "String",
      "Description": "Mode baca/tulis dari titik koneksi kluster. Nilai yang valid: ReadWrite: menerima dan meneruskan permintaan baca dan tulis (pemisahan baca-tulis otomatis). ReadOnly: menerima dan meneruskan hanya permintaan baca. Nilai default: ReadOnly.",
      "AllowedValues": [
        "ReadOnly",
        "ReadWrite"
      ]
    },
    "EndpointConfig": {
      "Type": "Json",
      "Description": ""
    },
    "AutoAddNewNodes": {
      "Default": "Disable",
      "Type": "String",
      "Description": "Menentukan apakah node yang baru ditambahkan secara otomatis ditambahkan ke titik koneksi ini.\nNilai yang valid: Enable, Disable.\nNilai default: Disable.",
      "AllowedValues": [
        "Disable",
        "Enable"
      ]
    },
    "Nodes": {
      "MinLength": 2,
      "Type": "CommaDelimitedList",
      "Description": "Node yang akan ditambahkan ke titik koneksi ini untuk memproses permintaan baca dari titik koneksi ini. Tambahkan setidaknya dua node.\nJika Anda tidak menentukan parameter ini, semua node kluster secara default ditambahkan ke titik koneksi ini."
    },
    "EndpointType": {
      "Default": "Custom",
      "Type": "String",
      "Description": "Jenis titik koneksi kluster. Tetapkan parameter ini ke Custom."
    }
  },
  "Outputs": {
    "DBEndpointId": {
      "Description": "ID titik akhir kluster DB. Contoh: pe-xxxxxxxx.",
      "Value": {
        "Fn::GetAtt": [
          "DBClusterEndpoint",
          "DBEndpointId"
        ]
      }
    },
    "ConnectionString": {
      "Description": "String koneksi pertama dari titik akhir kluster db.",
      "Value": {
        "Fn::GetAtt": [
          "DBClusterEndpoint",
          "ConnectionString"
        ]
      }
    },
    "Addresses": {
      "Description": "Item alamat dari titik akhir kluster db.",
      "Value": {
        "Fn::GetAtt": [
          "DBClusterEndpoint",
          "Addresses"
        ]
      }
    }
  }
}