全部產品
Search
文件中心

:ALIYUN::POLARDB::DBNodes

更新時間:Oct 25, 2024

ALIYUN::POLARDB::DBNodes類型用於增加PolarDB叢集節點。

文法

 {
  "Type": "ALIYUN::POLARDB::DBNodes",
  "Properties": {
    "DBClusterId": String,
    "Amount": Integer,
    "ImciSwitch": String,
    "ResourceGroupId": String,
    "DBNodeType": String,
    "EndpointBindList": List,
    "PlannedEndTime": String,
    "PlannedStartTime": String
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

DBClusterId

String

叢集ID。

無。

Amount

Integer

添加到叢集的節點數。

無。

ImciSwitch

String

是否開啟列存索引。

取值:

  • ON:開啟。

  • OFF:關閉。

ResourceGroupId

String

資源群組ID。

DBNodeType

String

節點類型。

取值:

  • RO

  • STANDBY

  • DLNode

EndpointBindList

List

指定新增節點需要加入的叢集串連地址的地址 ID。

說明

您可以通過調用DescribeDBClusterEndpoints介面查看叢集串連地址的詳情,包括串連地址 ID。

支援填入預設叢集串連地址和自訂叢集串連地址的地址 ID。

若該參數留空,預設將新增節點加入所有開啟了新節點自動加入功能(即AutoAddNewNodes取值為Enable)的叢集串連地址。

PlannedEndTime

String

開始執行目標定時任務的最晚時間。

格式為YYYY-MM-DDThh:mm:ssZ(UTC)。

說明

最晚時間需晚於開始時間的 30 分鐘或以上。

若設定了PlannedStartTime但未指定該參數,執行目標任務的最晚時間預設為開始時間+30 分鐘。例如當設定PlannedStartTime2021-01-14T09:00:00Z且該參數留空時,目標任務最晚將於2021-01-14T09:30:00Z開始執行。

PlannedStartTime

String

開始執行定時(即在目標時間段內執行)新增節點任務的最早時間。

格式為YYYY-MM-DDThh:mm:ssZ(UTC)。

說明

開始時間的取值範圍為未來 24 小時內的任意時間點。例如目前時間為2021-01-14T09:00:00Z,此處允許填入的開始時間範圍為2021-01-14T09:00:00Z~2021-01-15T09:00:00Z

若該參數留空,預設立即執行新增節點任務。

傳回值

Fn::GetAtt

  • DBNodeIds:添加到叢集的節點ID。

  • OrderIds:訂單ID。

樣本

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Type: String
    Description: The ID of the ApsaraDB for POLARDB cluster to be added nodes to.
Resources:
  DBNodes:
    Type: ALIYUN::POLARDB::DBNodes
    Properties:
      DBClusterId:
        Ref: DBClusterId
      Amount: 1
Outputs:
  DBNodeIds:
    Description: The ID list of added cluster nodes.
    Value:
      Fn::GetAtt:
        - DBNodes
        - DBNodeIds
  OrderIds:
    Description: The order ID list of added cluster nodes.
    Value:
      Fn::GetAtt:
        - DBNodes
        - OrderIds
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": "The ID of the ApsaraDB for POLARDB cluster to be added nodes to."
    }
  },
  "Resources": {
    "DBNodes": {
      "Type": "ALIYUN::POLARDB::DBNodes",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "Amount": 1
      }
    }
  },
  "Outputs": {
    "DBNodeIds": {
      "Description": "The ID list of added cluster nodes.",
      "Value": {
        "Fn::GetAtt": [
          "DBNodes",
          "DBNodeIds"
        ]
      }
    },
    "OrderIds": {
      "Description": "The order ID list of added cluster nodes.",
      "Value": {
        "Fn::GetAtt": [
          "DBNodes",
          "OrderIds"
        ]
      }
    }
  }
}