查詢已創建的負載均衡實例。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
slb:DescribeLoadBalancers | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 傳統型負載均衡實例的地域 ID。 您可以通過調用 DescribeRegions 接口查詢地域 ID。 | cn-hangzhou |
ServerId | string | 否 | 添加的后端服務器 ID。 | i-2zebcbq****** |
AddressIPVersion | string | 否 | IP 版本,可以設置為 ipv4 或者 ipv6。 | ipv4 |
LoadBalancerStatus | string | 否 | 實例狀態。取值:
| active |
LoadBalancerId | string | 否 | 傳統型負載均衡實例 ID。 支持多值查詢,最多可輸入 10 個 ID,以半角逗號(,)分隔。 | lb-bp1b6c719dfa**** |
LoadBalancerName | string | 否 | 傳統型負載均衡實例名稱。 長度為 1~80 個英文或中文字符,必須以大小字母或中文開頭,可包含數字、半角句號(.)、下劃線(_)和短劃線(-)。 支持多值查詢,最多可輸入 10 個名稱,以半角逗號(,)分隔。 | test |
ServerIntranetAddress | string | 否 | 添加的后端服務器的內網地址。 支持多值查詢,以半角逗號(,)分隔。 | 10.XX.XX.102 |
AddressType | string | 否 | 傳統型負載均衡實例的網絡類型。取值:
| intranet |
InternetChargeType | string | 否 | 公網計費方式。取值:
當 PayType 參數的值為 PrePay 時,只支持按帶寬計費。當 InstanceChargeType 參數的值為 PayByCLCU 時,只支持按流量計費。 | paybytraffic |
VpcId | string | 否 | 傳統型負載均衡實例所屬的 VPC ID。 | vpc-bp1aevy8sof**** |
VSwitchId | string | 否 | 傳統型負載均衡實例所屬的交換機 ID。 | vsw-bp12mw1f8k3**** |
NetworkType | string | 否 | 私網實例的網絡類型。取值:
| vpc |
Address | string | 否 | 傳統型負載均衡實例的服務地址。 | 192.168.XX.XX |
MasterZoneId | string | 否 | 負載均衡實例的主可用區 ID。 | cn-hangzhou-b |
SlaveZoneId | string | 否 | 傳統型負載均衡實例的備可用區 ID。 目前對金融云用戶暫時不支持多可用區功能。 | cn-hangzhou-d |
Tags | string | 否 | 傳統型負載均衡實例綁定的標簽列表,其結構是一個 JSON dictionary,包含標簽鍵和標簽值。 一次請求中,綁定的標簽列表中最多支持 10 個標簽。 | [{"tagKey":"Key1","tagValue":"Value1"}] |
PayType | string | 否 | 傳統型負載均衡實例付費模式。取值:
| PayOnDemand |
ResourceGroupId | string | 否 | 企業資源組 ID。 | rg-acfmxazb4p**** |
PageNumber | integer | 否 | 分頁查詢時的頁碼。 | 1 |
PageSize | integer | 否 | 分頁查詢時設置的每頁行數。 取值范圍:1~100。 說明
如果設置了 PageSize,則需要同時設置 PageNumber。
| 50 |
Tag | array<object> | 否 | 標簽列表。 | |
object | 否 | 標簽列表。 | ||
Key | string | 否 | 資源的標簽鍵。N 的取值范圍:1~20。一旦輸入該值,則不允許為空字符串。 最多支持 64 個字符,不能以 | FinanceDept |
Value | string | 否 | 資源的標簽值。N 的取值范圍:1~20。一旦輸入該值,可以為空字符串。
最多支持 128 個字符,不能以 | FinanceJoshua |
返回參數
示例
正常返回示例
JSON
格式
{
"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": "托管實例",
"ModificationProtectionStatus": "ConsoleProtection",
"VSwitchId": "vsw-255ecr****",
"LoadBalancerStatus": "active",
"ResourceGroupId": "rg-atstuj3r****",
"InternetChargeType": "3",
"DeleteProtection": "off",
"RegionIdAlias": "cn-hangzhou",
"Tags": {
"Tag": [
{
"TagValue": "testvalue",
"TagKey": "testkey"
}
]
},
"InstanceChargeType": "PayBySpec"
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidTag | The specified tags is invalid. | 指定的TagKey無效。請檢查參數約束,并在修改后重試。 |
400 | TooManyResult | fuzzy query retrieve too many instances. | 檢索到的實例數量過多,請提供更具體的查詢條件。 |
400 | LocationServiceTimeout | Location service connection timeout. Please try again later. | Location服務連接超時,請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-09-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-07-04 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |