DATASOURCE::NLB::LoadBalancers类型用于查询已创建的网络型负载均衡实例的基本信息。

语法

{
  "Type": "DATASOURCE::NLB::LoadBalancers",
  "Properties": {
    "LoadBalancerNames": List,
    "AddressIpVersion": String,
    "LoadBalancerBussinessStatus": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "VpcIds": List,
    "LoadBalancerIds": List,
    "AddressType": String,
    "LoadBalancerStatus": String,
    "Tags": List,
    "Ipv6AddressType": String
  }
}

属性

属性名称类型必须允许更新描述约束
LoadBalancerNamesList否是网络型负载均衡实例名称。一次最多支持查询20个实例。
AddressIpVersionString否是协议版本。取值：
  • ipv4：IPv4类型。
  • DualStack：双栈类型。
LoadBalancerBussinessStatusString否是网络型负载均衡的业务状态。取值：
  • Abnormal：异常状态。
  • Normal：正常状态。
ZoneIdString否是可用区ID。无
ResourceGroupIdString否是资源组ID。无
VpcIdsList否是网络型负载均衡实例的专有网络ID列表。一次最多支持查询10个VPC ID。
LoadBalancerIdsList否是网络型负载均衡实例的ID列表。一次最多支持查询20个实例。
AddressTypeString否是网络型负载均衡的IPv4地址类型。取值：
  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
LoadBalancerStatusString否是网络型负载均衡实例状态。取值：
  • Inactive：已停止，表示实例监听不会再转发流量。
  • Active：运行中。
  • Provisioning：创建中。
  • Configuring：变配中。
  • Deleting：删除中。
  • Deleted：已删除。
TagsList否是资源绑定的标签。一次最多支持添加20个标签。
Ipv6AddressTypeString否是网络型负载均衡的IPv6地址类型。取值：
  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。

Tags语法

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags属性

属性名称类型必须允许更新描述约束
ValueString否否标签值。长度为0~128个字符，不能以aliyun和acs:开头，不能包含http://或者https:// 。
KeyString是否标签键。长度为1~128个字符，不能以aliyun和acs:开头，不能包含http://或者https:// 。

返回值

Fn::GetAtt

  • LoadBalancerIds：网络型负载均衡实例ID列表。
  • LoadBalancers：网络型负载均衡实例列表。
属性名称类型描述约束
LoadBalancerIdsList网络型负载均衡实例ID列表。无
LoadBalancersList网络型负载均衡实例列表。无
LoadBalancerIdString网络型负载均衡实例ID。无
LoadBalancerNameString网络型负载均衡实例名称。无
LoadBalancerTypeString负载均衡实例类型。取值：Network，表示网络型负载均衡。
AddressTypeString网络型负载均衡的IPv4地址类型。取值：
  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
AddressIpVersionString协议版本。取值：
  • ipv4：IPv4类型。
  • DualStack：双栈类型。
Ipv6AddressTypeString网络型负载均衡的IPv6地址类型。取值：
  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
LoadBalancerStatusString网络型负载均衡实例状态。取值：
  • Inactive：已停止，表示实例监听不会再转发流量。
  • Active：运行中。
  • Provisioning：创建中。
  • Configuring：变配中。
  • Deleting：删除中。
  • Deleted：已删除。
LoadBalancerBusinessStatusString网络型负载均衡的业务状态。取值：
  • Abnormal：异常状态。
  • Normal：正常状态。
VpcIdString网络型负载均衡实例的专有网络ID。无
CreateTimeString资源创建时间。使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。
ResourceGroupIdString资源组ID。无
DNSNameStringDNS域名。无
BandwidthPackageIdString公网类型实例关联的共享带宽包ID。无
SecurityGroupIdsList网络型负载均衡实例加入的安全组。[ "sg-bp67acfmxazb4p****" ]
CrossZoneEnabledBoolean网络型负载均衡实例是否开启跨可用区。取值：
  • true：开启跨可用区。
  • false：关闭跨可用区。
TagsList标签列表。例如：
[ {
      "Key" : "KeyTest",
      "Value" : "ValueTest"
    } ]
PayTypeString网络型负载均衡实例的计费类型。取值：PostPay，表示按量计费。

示例

  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::NLB::LoadBalancers
    Properties:
      AddressIpVersion: ipv4
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

  • JSON格式

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::NLB::LoadBalancers",
      "Properties": {
        "AddressIpVersion": "ipv4"
      }
    }
  },
  "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"
        ]
      }
    }
  }
}