AI 助理
文档备案控制台
官方文档
首页 资源编排 开发参考 资源类型 SLB DATASOURCE::SLB::LoadBalancers

DATASOURCE::SLB::LoadBalancers

更新时间：
复制 MD 格式
产品详情
我的收藏

DATASOURCE::SLB::LoadBalancers类型用于查询已创建的传统型负载均衡实例。

语法

{
  "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: 实例已锁定。当负载均衡实例到期后，但到期时间未超过7天时，负载均衡实例进入锁定状态。此种状态下，您不能对负载均衡实例进行任何操作，实例不再会进行流量转发，但会保留实例的IP和其它配置。

AddressIpVersion

String

否

是

IP版本。

取值：

  • ipv4

  • ipv6

ResourceGroupId

String

否

是

企业资源组ID。

无

Address

String

否

是

传统型负载均衡实例的服务地址。

无

VSwitchId

String

否

是

传统型负载均衡实例所属的交换机ID。

无

LoadBalancerId

String

否

是

传统型负载均衡实例ID。

支持多值查询，最多可输入10个ID，以半角逗号（,）分隔。

SlaveZoneId

String

否

是

传统型负载均衡实例的备可用区ID。

无

InternetChargeType

String

否

是

公网计费方式。

取值：

  • paybybandwidth：按带宽计费。

  • paybytraffic：按流量计费。

说明

  • 当PayType参数的值为PrePay时，该参数只支持按带宽计费。

  • 当InstanceChargeType参数的值为PayByCLCU时，该参数只支持按流量计费。

LoadBalancerName

String

否

是

传统型负载均衡实例名称。

长度为1~80个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。支持多值查询，最多可输入10个名称，以半角逗号（,）分隔。

VpcId

String

否

是

传统型负载均衡实例所属的VPC ID。

无

NetworkType

String

否

是

私网实例的网络类型。

取值：

  • vpc：专有网络实例。

  • classic：经典网络实例。

PaymentType

String

否

是

付费类型。

无

AddressType

String

否

是

传统型负载均衡实例的网络类型。

取值：

  • internet：创建公网负载均衡实例后，系统会分配一个公网IP地址，可以转发公网请求。

  • intranet：创建内网负载均衡实例后，系统会分配一个内网IP地址，仅可转发内网请求。

MasterZoneId

String

否

是

负载均衡实例的主可用区ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

  • Never（默认值）：更新堆栈时，从不刷新数据源资源。

  • Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

  • LoadBalancerIds：负载均衡实例ID列表。

  • LoadBalancers：负载均衡实例详情列表。

名称

类型

描述

约束

LoadBalancerIds

List

负载均衡实例ID列表。

无

LoadBalancers

List

负载均衡实例详情列表。

无

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: 实例已锁定。当负载均衡实例到期后，但到期时间未超过7天时，负载均衡实例进入锁定状态。此种状态下，您不能对负载均衡实例进行任何操作，并且实例不再进行流量转发，但会保留实例的IP和其它配置。

AddressType

String

传统型负载均衡实例的网络类型。

取值：

  • internet：创建公网负载均衡实例后，系统会分配一个公网IP地址，可以转发公网请求。

  • intranet：创建内网负载均衡实例后，系统会分配一个内网IP地址，仅可转发内网请求。

RegionIdAlias

String

传统型负载均衡实例的地域名称。

无

Tags

List

标签列表。

无

RegionId

String

负载均衡实例的地域ID。

无

ResourceGroupId

String

企业资源组ID。

无

CreateTimeStamp

String

实例创建时间戳。

无

VSwitchId

String

私网负载均衡实例的交换机ID。

无

Address

String

负载均衡实例服务地址。

无

MasterZoneId

String

实例的主可用区ID。

无

LoadBalancerName

String

负载均衡实例的名称。

无

VpcId

String

私网负载均衡实例的专有网络ID。

无

LoadBalancerSpec

String

负载均衡实例的性能规格。

无

DeleteProtection

String

负载均衡删除保护状态。

取值：

  • on：开启删除保护状态。

  • off：关闭删除保护状态。

ModificationProtectionReason

String

托管实例。

设置修改保护状态的原因，长度为1~80个字符，必须以字母或中文开头，支持数字、半角句号（.）、下划线（_）和短划线（-）。

说明

当ModificationProtectionStatus取值为ConsoleProtection时，该参数才生效。

SlaveZoneId

String

实例的备可用区ID。

无

PaymentType

String

付费类型。

无

Bandwidth

Integer

监听的带宽峰值。

单位：Mbps。

取值：

  • -1：对于按流量计费的公网负载均衡实例，可以将带宽峰值设置为-1，即不限制带宽峰值。

  • 1~5120：对于按带宽计费的公网负载均衡实例，可以设置每个监听的带宽峰值，但所有监听的带宽峰值之和不能超过实例的带宽峰值。

LoadBalancerId

String

负载均衡实例ID。

无

NetworkType

String

私网负载均衡实例的网络类型。

取值：

  • 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
上一篇：DATASOURCE::SLB::LoadBalancer下一篇：DATASOURCE::SLB::LoadBalancerTCPListener