GetLoadBalancerAttribute - Server Load Balancer - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	GetLoadBalancerAttribute	The operation that you want to perform. Set the value to GetLoadBalancerAttribute.
LoadBalancerId	String	Yes	lb-bp1h66tp5uat84khm****	The ID of the ALB instance.

Response parameters


Parameter	Type	Example	Description
AccessLogConfig	Object		The configuration of the access log feature.
LogProject	String	sls-setter	The log project.
LogStore	String	test	The Logstore.
AddressAllocatedMode	String	Dynamic	The IP address allocation mode. Valid values: Fixed: allocates a static IP address to the ALB instance. Dynamic (default): dynamically allocates an IP address to each zone of the ALB instance.
AddressType	String	Intranet	The type of IPv4 address that is used by the ALB instance. Valid values: Internet: The ALB instance uses a public IP address. The domain name of the ALB instance is resolved to the public IP address. Therefore, the ALB instance can be accessed over the Internet. Intranet: The ALB instance uses a private IP address. The domain name of the ALB instance is resolved to the private IP address. Therefore, the ALB instance can be accessed over the virtual private cloud (VPC) where the ALB instance is deployed.
BandwidthPackageId	String	cbwp-bp1vevu8h3ieh****	The ID of the EIP bandwidth plan that is associated with the ALB instance if the ALB instance uses a public IP address.
CreateTime	String	2019-06-03T17:22Z	The time when the resource was created. The time is displayed in UTC in `yyyy-MM-ddTHH:mm:ssZ` format.
DNSName	String	alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com	The domain name of the ALB instance.
DeletionProtectionConfig	Object		The configuration of the deletion protection feature.
Enabled	Boolean	true	Indicates whether deletion protection is enabled. Valid values: true: enabled false: disabled
EnabledTime	String	2019-06-03T17:22Z	The time when deletion protection was enabled. The time is displayed in UTC in `yyyy-MM-ddTHH:mm:ssZ` format.
LoadBalancerBillingConfig	Object		The configuration of the billing method.
PayType	String	PostPay	The billing method. The value PostPay is returned. The value indicates the pay-as-you-go billing method.
LoadBalancerBussinessStatus	String	Normal	The business status of the ALB instance. Valid values: Abnormal: The ALB instance is not working as expected. Normal: The ALB instance is working as expected.
LoadBalancerEdition	String	Standard	The edition of the ALB instance. Different editions have different limits and support different billing methods. Valid values: Basic: Basic Edition Standard: Standard Edition
LoadBalancerId	String	lb-bp1o94dp5i6ea****	The ID of the ALB instance.
LoadBalancerName	String	alb1	The name of the ALB instance.
LoadBalancerOperationLocks	Array of LoadBalancerOperationLock		The configuration of the operation lock.
LockReason	String	OverduePayments	The reason why the ALB instance is locked. This parameter is available only if LoadBalancerBussinessStatus is set to Abnormal.
LockType	String	FinancialLocked	The type of lock. Valid values: SecurityLocked: The ALB instance is locked due to security reasons RelatedResourceLocked: The ALB instance is locked due to association issues. FinancialLocked: The ALB instance is locked due to overdue payments. ResidualLocked: The ALB instance is locked because the associated EIP bandwidth plans are released.
LoadBalancerStatus	String	Active	The status of the ALB instance. Valid values: inactive: The ALB instance is disabled. ALB instances in the inactive state do not forward traffic. Active (default): The ALB instance is running. Provisioning: The ALB instance is being created. Configuring: The ALB instance is being modified. CreateFailed: The system failed to create the ALB instance. In this case, you are not charged for the ALB instance. You can only delete the ALB instance.
ModificationProtectionConfig	Object		The configuration of the configuration read-only mode.
Reason	String	ManageInstance	The reason why the configuration read-only mode is enabled. The reason must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter. This parameter is available only if the ModificationProtectionStatus parameter is set to ConsoleProtection.
Status	String	ConsoleProtection	Indicates whether the configuration read-only mode is enabled for the ALB instance. Valid values: NonProtection: The configuration read-only mode is disabled. In this case, you cannot set the ModificationProtectionReason parameter. If you set the ModificationProtectionReason parameter, the value of the parameter is cleared. ConsoleProtection: The configuration read-only mode is enabled. In this case, you can set the ModificationProtectionReason parameter.
RegionId	String	cn-hangzhou	The ID of the region where the ALB instance is deployed.
RequestId	String	365F4154-92F6-4AE4-92F8-7FF34B540710	The ID of the request.
ResourceGroupId	String	rg-atstuj3rtop****	The ID of the resource group.
Tags	Array of Tag		The tags that are added to the ALB instance.
Key	String	FinanceDept	The key of the tag. The key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The key cannot contain `http://` or `https://`.
Value	String	FinanceJoshua	The value of the tag. The value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The value cannot contain `http://` or `https://`.
VpcId	String	vpc-25dvz****	The ID of the VPC where the ALB instance is deployed.
ZoneMappings	Array of ZoneMapping		The zones and the vSwitches in the zones. You must specify at least two zones.
LoadBalancerAddresses	Array of LoadBalancerAddress		The IP addresses that are used by the ALB instance.
Address	String	192.168.10.1	The IPv4 address that is used by the ALB instance. This parameter is available only if AddressIPVersion is set to IPv4. The AddressType parameter determines whether the IPv4 address is public or private.
Ipv6Address	String	2408:XXXX:39d:eb00::/56	The IPv6 address that is used by the ALB instance. This parameter is available only if AddressIPVersion is set to DualStack. The AddressType parameter determines whether the IPv6 address is public or private.
VSwitchId	String	vsw-12234****	The ID of the vSwitch in the zone. You can specify only one vSwitch (subnet) in each zone of an ALB instance.
ZoneId	String	cn-hangzhou-a	The name of the zone.
AddressIpVersion	String	DualStack	The protocol version. Valid values: IPv4: IPv4 DualStack: dual stack
Ipv6AddressType	String	Intranet	The type of IPv6 address that is used by the ALB instance. Valid values: Internet: The ALB instance uses a public IP address. The domain name of the ALB instance is resolved to the public IP address. Therefore, the ALB instance can be accessed over the Internet. Intranet: The ALB instance uses a private IP address. The domain name of the ALB instance is resolved to the private IP address. Therefore, the ALB instance can be accessed over the VPC where the ALB instance is deployed.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetLoadBalancerAttribute
&LoadBalancerId=lb-bp1h66tp5uat84khm****
&<Common request parameters>

Sample responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetLoadBalancerAttributeResponse>
    <AccessLogConfig>
        <LogProject>sls-setter</LogProject>
        <LogStore>test</LogStore>
    </AccessLogConfig>
    <AddressAllocatedMode>Dynamic</AddressAllocatedMode>
    <AddressType>Intranet</AddressType>
    <BandwidthPackageId>cbwp-bp1vevu8h3ieh****</BandwidthPackageId>
    <CreateTime>2019-06-03T17:22Z</CreateTime>
    <DNSName>alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com</DNSName>
    <DeletionProtectionConfig>
        <Enabled>true</Enabled>
        <EnabledTime>2019-06-03T17:22Z</EnabledTime>
    </DeletionProtectionConfig>
    <LoadBalancerBillingConfig>
        <PayType>PostPay</PayType>
    </LoadBalancerBillingConfig>
    <LoadBalancerBussinessStatus>Normal</LoadBalancerBussinessStatus>
    <LoadBalancerEdition>Standard</LoadBalancerEdition>
    <LoadBalancerId>lb-bp1o94dp5i6ea****</LoadBalancerId>
    <LoadBalancerName>alb1</LoadBalancerName>
    <LoadBalancerOperationLocks>
        <LockReason>OverduePayments</LockReason>
        <LockType>FinancialLocked</LockType>
    </LoadBalancerOperationLocks>
    <LoadBalancerStatus>Active</LoadBalancerStatus>
    <ModificationProtectionConfig>
        <Reason>ManageInstance</Reason>
        <Status>ConsoleProtection</Status>
    </ModificationProtectionConfig>
    <RegionId>cn-hangzhou</RegionId>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
    <Tags>
        <Key>FinanceDept</Key>
        <Value>FinanceJoshua</Value>
    </Tags>
    <VpcId>vpc-25dvz****</VpcId>
    <ZoneMappings>
        <LoadBalancerAddresses>
            <Address>192.168.10.1</Address>
            <Ipv6Address>2408:XXXX:39d:eb00::/56</Ipv6Address>
        </LoadBalancerAddresses>
        <VSwitchId>vsw-12234****</VSwitchId>
        <ZoneId>cn-hangzhou-a</ZoneId>
    </ZoneMappings>
    <AddressIpVersion>DualStack</AddressIpVersion>
    <Ipv6AddressType>Intranet</Ipv6AddressType>
</GetLoadBalancerAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "AccessLogConfig" : {
    "LogProject" : "sls-setter",
    "LogStore" : "test"
  },
  "AddressAllocatedMode" : "Dynamic",
  "AddressType" : "Intranet",
  "BandwidthPackageId" : "cbwp-bp1vevu8h3ieh****",
  "CreateTime" : "2019-06-03T17:22Z",
  "DNSName" : "alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com",
  "DeletionProtectionConfig" : {
    "Enabled" : true,
    "EnabledTime" : "2019-06-03T17:22Z"
  },
  "LoadBalancerBillingConfig" : {
    "PayType" : "PostPay"
  },
  "LoadBalancerBussinessStatus" : "Normal",
  "LoadBalancerEdition" : "Standard",
  "LoadBalancerId" : "lb-bp1o94dp5i6ea****",
  "LoadBalancerName" : "alb1",
  "LoadBalancerOperationLocks" : [ {
    "LockReason" : "OverduePayments",
    "LockType" : "FinancialLocked"
  } ],
  "LoadBalancerStatus" : "Active",
  "ModificationProtectionConfig" : {
    "Reason" : "ManageInstance",
    "Status" : "ConsoleProtection"
  },
  "RegionId" : "cn-hangzhou",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "ResourceGroupId" : "rg-atstuj3rtop****",
  "Tags" : [ {
    "Key" : "FinanceDept",
    "Value" : "FinanceJoshua"
  } ],
  "VpcId" : "vpc-25dvz****",
  "ZoneMappings" : [ {
    "LoadBalancerAddresses" : [ {
      "Address" : "192.168.10.1",
      "Ipv6Address" : "2408:XXXX:39d:eb00::/56"
    } ],
    "VSwitchId" : "vsw-12234****",
    "ZoneId" : "cn-hangzhou-a"
  } ],
  "AddressIpVersion" : "DualStack",
  "Ipv6AddressType" : "Intranet"
}

Error code


HttpCode	Error code	Error message	Description
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.	The error message returned because the specified resource %s does not exist.

For a list of error codes, visit the API Error Center.