全部產品
Search
文件中心

:DATASOURCE::SLB::LoadBalancers

更新時間:Nov 28, 2024

DATASOURCE::SLB::LoadBalancers類型用於查詢已建立的傳統型Server Load Balancer執行個體。

文法

{
  "Type": "DATASOURCE::SLB::LoadBalancers",
  "Properties": {
    "Status": String,
    "AddressIpVersion": String,
    "ResourceGroupId": String,
    "Address": String,
    "VSwitchId": String,
    "LoadBalancerId": String,
    "SlaveZoneId": String,
    "InternetChargeType": String,
    "LoadBalancerName": String,
    "VpcId": String,
    "NetworkType": String,
    "PaymentType": String,
    "AddressType": String,
    "MasterZoneId": String,
    "RefreshOptions": String
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

Status

String

執行個體狀態。

取值:

  • inactive: 執行個體已停止,此狀態的執行個體監聽不會再轉寄流量。

  • active: 執行個體運行中,執行個體建立後,預設狀態為active。

  • locked: 執行個體鎖定。當Server Load Balancer執行個體到期後,但到期時間未超過7天時,Server Load Balancer執行個體進入鎖定狀態。此種狀態下,您不能對Server Load Balancer執行個體進行任何操作,執行個體不再會進行流量轉寄,但會保留執行個體的IP和其它配置。

AddressIpVersion

String

IP版本。

取值:

  • ipv4

  • ipv6

ResourceGroupId

String

企業資源組ID。

Address

String

傳統型Server Load Balancer執行個體的服務地址。

VSwitchId

String

傳統型Server Load Balancer執行個體所屬的交換器ID。

LoadBalancerId

String

傳統型Server Load Balancer執行個體ID。

支援多值查詢,最多可輸入10個ID,以半形逗號(,)分隔。

SlaveZoneId

String

傳統型Server Load Balancer執行個體的備可用性區域ID。

InternetChargeType

String

公網計費方式。

取值:

  • paybybandwidth:按頻寬計費。

  • paybytraffic:按流量計費。

說明
  • 當PayType參數的值為PrePay時,該參數只支援按頻寬計費。

  • 當InstanceChargeType參數的值為PayByCLCU時,該參數只支援按流量計費。

LoadBalancerName

String

傳統型Server Load Balancer執行個體名稱。

長度為1~80個英文或中文字元,必須以大小字母或中文開頭,可包含數字、半形句號(.)、底線(_)和短劃線(-)。支援多值查詢,最多可輸入10個名稱,以半形逗號(,)分隔。

VpcId

String

傳統型Server Load Balancer執行個體所屬的VPC ID。

NetworkType

String

私網執行個體的網路類型。

取值:

  • vpc:專用網路執行個體。

  • classic:傳統網路執行個體。

PaymentType

String

付費類型。

AddressType

String

傳統型Server Load Balancer執行個體的網路類型。

取值:

  • internet:建立公網Server Load Balancer執行個體後,系統會分配一個公網IP地址,可以轉寄公網請求。

  • intranet:建立內網Server Load Balancer執行個體後,系統會分配一個內網IP地址,僅可轉寄內網請求。

MasterZoneId

String

Server Load Balancer執行個體的主可用性區域ID。

RefreshOptions

String

當資源棧更新時,資料來源資源的重新整理策略。

有效值:

  • Never(預設值):更新堆棧時,從不重新整理資料來源資源。

  • Always:更新堆棧時,始終重新整理資料來源資源。

傳回值

Fn::GetAtt

  • LoadBalancerIds:Server Load Balancer執行個體ID列表。

  • LoadBalancers:Server Load Balancer執行個體詳情列表。

名稱

類型

描述

約束

LoadBalancerIds

List

Server Load Balancer執行個體ID列表。

LoadBalancers

List

Server Load Balancer執行個體詳情列表。

ModificationProtectionStatus

String

負載平衡修改保護狀態。

取值:

  • NonProtection:不限制修改保護,設定後會清空之前設定的受管理的執行個體狀態。

  • ConsoleProtection:執行個體控制台修改保護狀態。

AddressIpVersion

String

IP版本。

取值:

  • ipv4

  • ipv6

InternetChargeType

String

公網類型執行個體付費方式。

取值:

  • 3:按頻寬計費(paybybandwidth)。

  • 4:按流量計費(paybytraffic)。

說明
  • 當PayType參數的值為PrePay時,該參數只支援按頻寬計費。

  • 當InstanceChargeType參數的值為PayByCLCU時,該參數只支援按流量計費。

Status

String

執行個體狀態。

取值:

  • inactive: 執行個體已停止,此狀態的執行個體監聽不會再轉寄流量。

  • active: 執行個體運行中,執行個體建立後,預設狀態為active。

  • locked: 執行個體鎖定。當Server Load Balancer執行個體到期後,但到期時間未超過7天時,Server Load Balancer執行個體進入鎖定狀態。此種狀態下,您不能對Server Load Balancer執行個體進行任何操作,並且執行個體不再進行流量轉寄,但會保留執行個體的IP和其它配置。

AddressType

String

傳統型Server Load Balancer執行個體的網路類型。

取值:

  • internet:建立公網Server Load Balancer執行個體後,系統會分配一個公網IP地址,可以轉寄公網請求。

  • intranet:建立內網Server Load Balancer執行個體後,系統會分配一個內網IP地址,僅可轉寄內網請求。

RegionIdAlias

String

傳統型Server Load Balancer執行個體的地區名稱。

Tags

List

標籤列表。

RegionId

String

Server Load Balancer執行個體的地區ID。

ResourceGroupId

String

企業資源組ID。

CreateTimeStamp

String

執行個體建立時間戳記。

VSwitchId

String

私網Server Load Balancer執行個體的交換器ID。

Address

String

Server Load Balancer執行個體服務地址。

MasterZoneId

String

執行個體的主可用性區域ID。

LoadBalancerName

String

Server Load Balancer執行個體的名稱。

VpcId

String

私網Server Load Balancer執行個體的專用網路ID。

LoadBalancerSpec

String

Server Load Balancer執行個體的效能規格。

DeleteProtection

String

負載平衡刪除保護狀態。

取值:

  • on:開啟刪除保護狀態。

  • off:關閉刪除保護狀態。

ModificationProtectionReason

String

受管理的執行個體。

設定修改保護狀態的原因,長度為1~80個字元,必須以字母或中文開頭,支援數字、半形句號(.)、底線(_)和短劃線(-)。

說明

當ModificationProtectionStatus取值為ConsoleProtection時,該參數才生效。

SlaveZoneId

String

執行個體的備可用性區域ID。

PaymentType

String

付費類型。

Bandwidth

Integer

監聽的頻寬峰值。

單位:Mbps。

取值:

  • -1:對於按流量計費的公網Server Load Balancer執行個體,可以將頻寬峰值設定為-1,即不限制頻寬峰值。

  • 1~5120:對於按頻寬計費的公網Server Load Balancer執行個體,可以設定每個監聽的頻寬峰值,但所有監聽的頻寬峰值之和不能超過執行個體的頻寬峰值。

LoadBalancerId

String

Server Load Balancer執行個體ID。

NetworkType

String

私網Server Load Balancer執行個體的網路類型。

取值:

  • vpc:專用網路執行個體。

  • classic:傳統網路執行個體。

CreateTime

String

執行個體建立時間。

格式為:YYYY-MM-DDThh:mm:ssZ。

樣本

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "LoadBalancerId": {
      "Type": "String",
      "Description": "ID of the load balancing instance."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::SLB::LoadBalancers",
      "Properties": {
        "LoadBalancerId": {
          "Ref": "LoadBalancerId"
        }
      }
    }
  },
  "Outputs": {
    "LoadBalancerIds": {
      "Description": "The list of load balancer IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancerIds"
        ]
      }
    },
    "LoadBalancers": {
      "Description": "The list of load balancers.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancers"
        ]
      }
    }
  }
}
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  LoadBalancerId:
    Type: String
    Description: ID of the load balancing instance.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::SLB::LoadBalancers
    Properties:
      LoadBalancerId:
        Ref: LoadBalancerId
Outputs:
  LoadBalancerIds:
    Description: The list of load balancer IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancerIds
  LoadBalancers:
    Description: The list of load balancers.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancers