使用DescribeLoadBalancers查詢Server Load Balancer執行個體-負載平衡-阿里雲 - Server Load Balancer

查詢已建立的Server Load Balancer執行個體。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

slb:DescribeLoadBalancers

get

*LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	傳統型Server Load Balancer執行個體的地區 ID。您可以通過調用 DescribeRegions 介面查詢地區 ID。	cn-hangzhou
ServerId	string	否	添加的後端伺服器 ID。	i-2zebcbq******
AddressIPVersion	string	否	IP 版本，可以設定為 ipv4 或者 ipv6。	ipv4
LoadBalancerStatus	string	否	執行個體狀態。取值： inactive: 執行個體已停止，此狀態的執行個體監聽不會再轉寄流量。 active: 執行個體運行中，執行個體建立後，預設狀態為 active。 locked: 執行個體鎖定。當Server Load Balancer執行個體到期後，但到期時間未超過 7 天時，Server Load Balancer執行個體進入鎖定狀態。此種狀態下，您不能對Server Load Balancer執行個體進行任何操作，並且執行個體不再會進行流量轉寄，但會保留執行個體的 IP 和其它配置。	active
LoadBalancerId	string	否	傳統型Server Load Balancer執行個體 ID。支援多值查詢，最多可輸入 10 個 ID，以半形逗號（,）分隔。	lb-bp1b6c719dfa****
LoadBalancerName	string	否	傳統型Server Load Balancer執行個體名稱。長度為 1~80 個英文或中文字元，必須以大小字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-）。支援多值查詢，最多可輸入 10 個名稱，以半形逗號（,）分隔。	test
ServerIntranetAddress	string	否	添加的後端伺服器的內網地址。支援多值查詢，以半形逗號（,）分隔。	10.XX.XX.102
AddressType	string	否	傳統型Server Load Balancer執行個體的網路類型。取值： internet：建立公網Server Load Balancer執行個體後，系統會分配一個公網 IP 位址，可以轉寄公網請求。 intranet：建立內網Server Load Balancer執行個體後，系統會分配一個內網 IP 位址，僅可轉寄內網請求。	intranet
InternetChargeType	string	否	公網計費方式。取值： paybybandwidth：按頻寬計費。 paybytraffic：按流量計費。	paybytraffic
VpcId	string	否	傳統型Server Load Balancer執行個體所屬的 VPC ID。	vpc-bp1aevy8sof****
VSwitchId	string	否	傳統型Server Load Balancer執行個體所屬的交換器 ID。	vsw-bp12mw1f8k3****
NetworkType	string	否	私網執行個體的網路類型。取值： vpc：專用網路類型。 classic：傳統網路類型。	vpc
Address	string	否	傳統型Server Load Balancer執行個體的服務地址。	192.168.XX.XX
MasterZoneId	string	否	Server Load Balancer執行個體的主可用性區域 ID。	cn-hangzhou-b
SlaveZoneId	string	否	傳統型Server Load Balancer執行個體的備可用性區域 ID。目前對金融雲使用者暫時不支援多可用性區域功能。	cn-hangzhou-d
Tags	string	否	傳統型Server Load Balancer執行個體綁定的標籤列表，其結構是一個 JSON dictionary，包含標籤鍵和標籤值。一次請求中，綁定的標籤列表中最多支援 10 個標籤。	[{"tagKey":"Key1","tagValue":"Value1"}]
PayType	string	否	傳統型Server Load Balancer執行個體付費模式。取值： PayOnDemand：隨用隨付。	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 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。N 的取值範圍：1~20。一旦輸入該值，可以為空白字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E
PageNumber	integer	執行個體列表頁碼。	1
PageSize	integer	當前分頁的行數。	50
TotalCount	integer	根據過濾條件得到的執行個體總個數。	1
LoadBalancers	object
LoadBalancer	array<object>	數組格式，返回Server Load Balancer執行個體列表。
	array<object>	數組格式，返回Server Load Balancer執行個體列表。
VpcId	string	私網Server Load Balancer執行個體的專用網路 ID。	vpc-25dvzy9f8****
CreateTimeStamp	integer	執行個體建立時間戳記。	1504147745000
LoadBalancerId	string	Server Load Balancer執行個體 ID。	lb-bp1b6c719dfa****
CreateTime	string	執行個體建立時間，格式為：`YYYY-MM-DDThh:mm:ssZ`。	2021-12-02T02:49:05Z
PayType	string	Server Load Balancer執行個體付費模式，取值： PayOnDemand：隨用隨付。	PayOnDemand
AddressType	string	執行個體的網路類型。取值： internet：建立公網Server Load Balancer執行個體後，系統會分配一個公網 IP 位址，可以轉寄公網請求。 intranet：建立內網Server Load Balancer執行個體後，系統會分配一個內網 IP 位址，僅可轉寄內網請求。	intranet
NetworkType	string	私網Server Load Balancer執行個體的網路類型，取值： vpc：專用網路類型。 classic：傳統網路類型。	vpc
AddressIPVersion	string	IP 版本，可以設定為 ipv4 或者 ipv6。	ipv4
LoadBalancerName	string	Server Load Balancer執行個體的名稱。	lb-bp1o94dp5i6ea****
Bandwidth	integer	監聽的頻寬峰值，單位：Mbps。	-1
Address	string	Server Load Balancer執行個體服務地址。	100.XX.XX.28
SlaveZoneId	string	執行個體的備可用性區域 ID。	cn-hangzhou-d
MasterZoneId	string	執行個體的主可用性區域 ID。	cn-hangzhou-b
InternetChargeTypeAlias	string	公網計費方式。取值： paybybandwidth：按頻寬計費。 paybytraffic：按流量計費	paybybandwidth
LoadBalancerSpec	string	Server Load Balancer執行個體的效能規格。說明按流量計費的執行個體無效能規格屬性，預設返回 slb.lcu.elastic。	slb.s1.small
RegionId	string	Server Load Balancer執行個體的地區 ID。	cn-hangzhou
ModificationProtectionReason	string	設定修改保護狀態的原因，長度為 1~80 個字元，必須以字母或中文開頭，支援數字、半形句號（.）、底線（_）和短劃線（-）。說明僅在`ModificationProtectionStatus`為 ConsoleProtection 時有效。	ManagedInstance
ModificationProtectionStatus	string	負載平衡修改保護狀態： NonProtection：不限制修改保護，設定後會清空之前設定的`ModificationProtectionReason`。 ConsoleProtection：執行個體控制台修改保護狀態。說明當取值為 ConsoleProtection，即開啟修改保護後，使用者不能通過負載平衡控制台修改執行個體配置，但可以通過調用 API 修改執行個體配置。	ConsoleProtection
VSwitchId	string	私網Server Load Balancer執行個體的交換器 ID。	vsw-255ecr****
LoadBalancerStatus	string	Server Load Balancer執行個體狀態。取值： inactive：執行個體已停止，此狀態的執行個體監聽不會再轉寄流量。 active：執行個體運行中，執行個體建立後，預設狀態為 active。 locked：執行個體鎖定，執行個體已經被鎖定。	active
ResourceGroupId	string	企業資源組 ID。	rg-atstuj3r****
InternetChargeType	string	公網類型執行個體付費方式。取值： 3：按頻寬計費（paybybandwidth）。 4：按流量計費（paybytraffic）。	3
DeleteProtection	string	負載平衡刪除保護狀態。取值： on：開啟。 off：關閉。	off
RegionIdAlias	string	傳統型Server Load Balancer執行個體的地區名稱。	cn-hangzhou
Tags	object
Tag	array<object>	標籤列表
	object	標籤列表
TagValue	string	標籤值。	testvalue
TagKey	string	標籤鍵。	testkey
InstanceChargeType	string	執行個體計費方式，取值： PayBySpec：按規格計費。 PayByCLCU：按使用量計費。說明該參數僅適用於中國站且當 PayType（執行個體付費模式）取值為 PayOnDemand（隨用隨付）時，該參數生效。	PayBySpec

樣本

正常返回樣本

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": "ManagedInstance",
        "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.
403	UnauthorizedRegion	The specified region of is not authorized.	指定地區不可見。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。