Queries Classic Load Balancer (CLB) instances.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| slb:DescribeLoadBalancers | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region where the CLB instance is deployed. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ServerId | string | No | The ID of the backend server that is added to the CLB instance. | vm-server-23**** |
| AddressIPVersion | string | No | The IP version that is used by the CLB instance. Valid values: ipv4 and ipv6. | ipv4 |
| LoadBalancerStatus | string | No | The status of the CLB instance. Valid values:
| active |
| LoadBalancerId | string | No | The ID of the CLB instance. You can specify up to 10 IDs. Separate multiple IDs with commas (,). | lb-bp1b6c719dfa**** |
| LoadBalancerName | string | No | The name of the CLB instance. The name must be 1 to 80 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter. You can specify up to 10 names. Separate multiple names with commas (,). | test |
| ServerIntranetAddress | string | No | The private IP address of the backend server that is added to the CLB instance. You can specify multiple IP addresses. Separate multiple IP addresses with commas (,). | 10.XX.XX.102 |
| AddressType | string | No | The network type of the CLB instance. Valid values:
| intranet |
| InternetChargeType | string | No | The metering method of Internet data transfer. Valid values:
| paybytraffic |
| VpcId | string | No | The ID of the virtual private cloud (VPC) to which the CLB instance belongs. | vpc-bp1aevy8sof**** |
| VSwitchId | string | No | The ID of the vSwitch to which the CLB instance belongs. | vsw-bp12mw1f8k3**** |
| NetworkType | string | No | The network type of the internal-facing CLB instance. Valid values:
| vpc |
| Address | string | No | The IP address that the CLB instance uses to provide services. | 192.168.XX.XX |
| MasterZoneId | string | No | The ID of the primary zone to which the CLB instance belongs. | cn-hangzhou-b |
| SlaveZoneId | string | No | The ID of the secondary zone to which the CLB instance belongs. CLB instances on Alibaba Finance Cloud do not support cross-zone deployment. | cn-hangzhou-d |
| Tags | string | No | The tags that are added to the CLB instance. The tags must be key-value pairs that are contained in a JSON dictionary. You can specify up to 10 tags in each call. | [{"tagKey":"Key1","tagValue":"Value1"}] |
| PayType | string | No | The billing method of the CLB instance. Valid values:
| PayOnDemand |
| ResourceGroupId | string | No | The ID of the resource group. | rg-acfmxazb4p**** |
| PageNumber | integer | No | The page number of the page to return. | 1 |
| PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 100. Note
If you specify the PageSize parameter, you must also specify the PageNumber parameter.
| 50 |
| Tag | array<object> | No | The tags. | |
| object | No | |||
| Key | string | No | The key of the tag. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key must be 1 to 64 characters in length and cannot start with | FinanceDept |
| Value | string | No | The value of the tag. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be at most 128 characters in length and cannot start with | FinanceJoshua |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E",
"PageNumber": 1,
"PageSize": 50,
"TotalCount": 1,
"LoadBalancers": {
"LoadBalancer": [
{
"VpcId": "vpc-25dvzy9f8****",
"CreateTimeStamp": 1504147745000,
"LoadBalancerId": "lb-bp1b6c719dfa****",
"CreateTime": "2021-12-02T02:49:05Z",
"PayType": "PayOnDemand",
"AddressType": "intranet",
"NetworkType": "vpc",
"AddressIPVersion": "ipv4",
"LoadBalancerName": "lb-bp1o94dp5i6ea****",
"Bandwidth": -1,
"Address": "100.XX.XX.28",
"SlaveZoneId": "cn-hangzhou-d",
"MasterZoneId": "cn-hangzhou-b",
"InternetChargeTypeAlias": "paybybandwidth",
"LoadBalancerSpec": "slb.s1.small",
"RegionId": "cn-hangzhou",
"ModificationProtectionReason": "ManagedInstance\n",
"ModificationProtectionStatus": "ConsoleProtection",
"VSwitchId": "vsw-255ecr****",
"LoadBalancerStatus": "active",
"ResourceGroupId": "rg-atstuj3r****",
"InternetChargeType": "3",
"DeleteProtection": "off",
"RegionIdAlias": "hangzhou",
"Tags": {
"Tag": [
{
"TagValue": "FinanceJoshua",
"TagKey": "FinanceDept"
}
]
},
"InstanceChargeType": "PayBySpec"
}
]
}
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidTag | The specified tags is invalid. |
| 400 | TooManyResult | fuzzy query retrieve too many instances. |
| 400 | LocationServiceTimeout | Location service connection timeout. Please try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-09-08 | The Error code has changed | View Change Details |
| 2023-07-04 | The Error code has changed. The request parameters of the API has changed | View Change Details |