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

语法

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

属性

属性名称类型必须允许更新描述约束
LoadBalancerNamesList否是实例名称列表。最多支持10个实例名称。长度为2~128个英文或中文字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。
LoadBalancerBussinessStatusString否是应用型负载均衡的业务状态。取值：
  • Abnormal：异常。
  • Normal：正常。
ZoneIdString否是应用型负载均衡实例所在的可用区ID。您可以通过调用DescribeZones接口获取可用区ID对应的可用区信息。
ResourceGroupIdString否是企业资源组ID。无
VpcIdsList否是应用型负载均衡实例所属的VPC ID。最多支持10个VPC ID。
LoadBalancerIdsList否是实例ID列表。最多支持20个实例ID。
PayTypeString否是实例的计费类型。取值：
  • PostPay（默认值）：表示按量计费。
  • PrePay：包年包月。
AddressTypeString否是实例地址类型。取值：
  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
LoadBalancerStatusString否是应用型负载均衡实例状态。取值：
  • Inactive： 已停止，监听不再转发流量。
  • Active:：运行中。
  • Provisioning：创建中。
  • Configuring：变配中。
  • CreateFailed：创建失败，此时不会产生费用，实例只能被删除。系统默认清理最近1天创建失败的实例。
TagsList否是实例绑定的标签。最多支持输入20个标签。更多信息，请参见Tags属性。

Tags语法

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

Tags属性

属性名称类型必须允许更新描述约束
ValueString否否实例的标签值。最多支持输入20个标签值。一旦输入该值，可以为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
KeyString是否实例的标签键。最多支持输入20个标签键。一旦输入该值，则不允许为空字符串。最多支持64个字符，不能以aliyun和acs:开头，不能包含http://或者https://。

返回值

Fn::GetAtt

  • LoadBalancerIds：负载均衡实例ID列表。
  • LoadBalancers：负载均衡实例列表。
属性名称类型描述约束
LoadBalancerIdsList负载均衡实例ID列表。无
LoadBalancersList负载均衡实例列表。无
AddressAllocatedModeString地址模式。取值：
  • Fixed：固定IP模式，表示使用固定IP地址。
  • Dynamic：动态IP模式，表示每个可用区动态分配IP地址。
AddressTypeString负载均衡的地址类型。取值：
  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
BandwidthPackageIdString公网类型实例关联的共享带宽包ID。无
CreateTimeString资源创建时间。无
DNSNameStringDNS域名。无
LoadBalancerBussinessStatusString负载均衡的业务状态。取值：
  • Abnormal：异常。
  • Normal：正常。
LoadBalancerEditionString负载均衡的版本。不同版本有不同功能限制和计费策略。取值：
  • Standard：标准版。
  • Basic：基础版。
  • StandardWithWaf：WAF增强版。
LoadBalancerIdString应用型负载均衡实例ID。无
LoadBalancerNameString负载均衡实例名称。无
LoadBalancerStatusString应用型负载均衡实例状态。取值：
  • Inactive： 已停止，监听不再转发流量。
  • Active:：运行中。
  • Provisioning：创建中。
  • Configuring：变配中。
  • CreateFailed：创建失败，此时不会产生费用，实例只能被删除。系统默认清理最近1天创建失败的实例。
ResourceGroupIdString企业资源组ID。无
VpcIdString应用型负载均衡实例的专有网络ID。无
AddressIpVersionString协议版本。取值：
  • IPv4：IPv4类型。
  • DualStack：双栈类型。
Ipv6AddressTypeString应用型负载均衡IPv6的网络地址类型。取值：
  • Internet：公网。负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：私网。负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
TagsList标签列表。例如：
[ {
      "Key" : "KeyTest",
      "Value" : "alueTest"
    } ]
LogProjectString日志项目。无
LogStoreString日志存储。无
PayTypeString实例的计费类型。取值：
  • PostPay：按量计费。
  • PrePay：包年包月。

示例

  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ALB::LoadBalancers
    Properties:
      LoadBalancerBussinessStatus: Normal
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::ALB::LoadBalancers",
      "Properties": {
        "LoadBalancerBussinessStatus": "Normal"
      }
    }
  },
  "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"
        ]
      }
    }
  }
}