使用DATASOURCE::NLB::LoadBalancers数据源查询网络型负载均衡实例-资源编排-阿里云

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,
    "RefreshOptions": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
LoadBalancerNames	List	否	是	网络型负载均衡实例名称。	一次最多支持查询20个实例。
AddressIpVersion	String	否	是	协议版本。	取值： ipv4：IPv4类型。 DualStack：双栈类型。
LoadBalancerBussinessStatus	String	否	是	网络型负载均衡的业务状态。	取值： Abnormal：异常状态。 Normal：正常状态。
ZoneId	String	否	是	可用区ID。	无
ResourceGroupId	String	否	是	资源组ID。	无
VpcIds	List	否	是	网络型负载均衡实例的专有网络ID列表。	一次最多支持查询10个VPC ID。
LoadBalancerIds	List	否	是	网络型负载均衡实例的ID列表。	一次最多支持查询20个实例。
AddressType	String	否	是	网络型负载均衡的IPv4地址类型。	取值： Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。 Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
LoadBalancerStatus	String	否	是	网络型负载均衡实例状态。	取值： Inactive：已停止，表示实例监听不会再转发流量。 Active：运行中。 Provisioning：创建中。 Configuring：变配中。 Deleting：删除中。 Deleted：已删除。
Tags	List	否	是	资源绑定的标签。	一次最多支持添加20个标签。
Ipv6AddressType	String	否	是	网络型负载均衡的IPv6地址类型。	取值： Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。 Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
RefreshOptions	String	否	是	当资源栈更新时，数据源资源的刷新策略。	有效值： Never（默认值）：更新堆栈时，从不刷新数据源资源。 Always：更新堆栈时，始终刷新数据源资源。

Tags语法

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

Tags属性

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

返回值

Fn::GetAtt

LoadBalancerIds：网络型负载均衡实例ID列表。
LoadBalancers：网络型负载均衡实例列表。

属性名称	类型	描述	约束
LoadBalancerIds	List	网络型负载均衡实例ID列表。	无
LoadBalancers	List	网络型负载均衡实例列表。	无
LoadBalancerId	String	网络型负载均衡实例ID。	无
LoadBalancerName	String	网络型负载均衡实例名称。	无
LoadBalancerType	String	负载均衡实例类型。	取值：Network，表示网络型负载均衡。
AddressType	String	网络型负载均衡的IPv4地址类型。	取值： Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。 Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
AddressIpVersion	String	协议版本。	取值： ipv4：IPv4类型。 DualStack：双栈类型。
Ipv6AddressType	String	网络型负载均衡的IPv6地址类型。	取值： Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。 Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
LoadBalancerStatus	String	网络型负载均衡实例状态。	取值： Inactive：已停止，表示实例监听不会再转发流量。 Active：运行中。 Provisioning：创建中。 Configuring：变配中。 Deleting：删除中。 Deleted：已删除。
LoadBalancerBusinessStatus	String	网络型负载均衡的业务状态。	取值： Abnormal：异常状态。 Normal：正常状态。
VpcId	String	网络型负载均衡实例的专有网络ID。	无
CreateTime	String	资源创建时间。	使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。
ResourceGroupId	String	资源组ID。	无
DNSName	String	DNS域名。	无
BandwidthPackageId	String	公网类型实例关联的共享带宽包ID。	无
SecurityGroupIds	List	网络型负载均衡实例加入的安全组。	[ "sg-bp67acfmxazb4p****" ]
CrossZoneEnabled	Boolean	网络型负载均衡实例是否开启跨可用区。	取值： true：开启跨可用区。 false：关闭跨可用区。
Tags	List	标签列表。	例如： `[ { "Key" : "KeyTest", "Value" : "ValueTest" } ]`
PayType	String	网络型负载均衡实例的计费类型。	取值：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"
        ]
      }
    }
  }
}