DescribeLoadBalancerAttribute查詢Server Load Balancer執行個體屬性-負載平衡-阿里雲 - Server Load Balancer

查詢指定Server Load Balancer執行個體的詳細資料。

介面說明

說明

如果後端伺服器設定在虛擬伺服器組下面，請調用 DescribeVServerGroupAttribute 查詢。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

slb:DescribeLoadBalancerAttribute

get

*loadbalancer

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

slb:tag
slb:tag
slb:tag
slb:tag
slb:tag

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	傳統型Server Load Balancer執行個體的地區 ID。您可以通過調用 DescribeRegions 介面查詢地區 ID。	cn-hangzhou
LoadBalancerId	string	是	傳統型Server Load Balancer執行個體 ID。	lb-bp1b6c719dfa08ex****

返回參數

名稱	類型	描述	樣本值
	object
VpcId	string	傳統型負載平衡私網執行個體的專用網路 ID。	vpc-25dvzy9f8****
Tags	object
Tag	array<object>	標籤列表。
	object	標籤列表。
TagKey	string	執行個體的標籤鍵。N 的取值範圍：1~20。一旦輸入該值，則不允許為空白字串。最多支援 64 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	test
TagValue	string	執行個體的標籤值。N 的取值範圍：1~20。一旦輸入該值，可以為空白字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	value
CreateTimeStamp	integer	傳統型Server Load Balancer執行個體建立時間戳記。	1504147745000
CreateTime	string	傳統型Server Load Balancer執行個體的建立時間。格式為：`YYYY-MM-DDThh:mm:ssZ`。	2017-08-31T02:49:05Z
LoadBalancerId	string	傳統型Server Load Balancer執行個體的 ID。	lb-bp1b6c719dfa08ex****
PayType	string	傳統型Server Load Balancer執行個體付費類型。取值： PayOnDemand（預設值）：隨用隨付。	PayOnDemand
AddressType	string	傳統型Server Load Balancer執行個體的地址類型。	internet
NetworkType	string	傳統型Server Load Balancer執行個體的網路類型。	vpc
AddressIPVersion	string	IP 版本。取值：ipv4 或 ipv6。	ipv4
RenewalCycUnit	string	自動續約周期，取值：Year 或 Month（預設值）。說明該參數僅適用於中國站訂用帳戶執行個體，即 PayType 的參數值為 PrePay 且 RenewalStatus 為 AutoRenewal 時有效。	Month
RequestId	string	請求 ID。	365F4154-92F6-4AE4-92F8-7FF34B540710
Bandwidth	integer	按頻寬計費的公網型執行個體的頻寬峰值。	5
LoadBalancerName	string	傳統型Server Load Balancer執行個體的名稱。	lb-instance-test
Address	string	傳統型Server Load Balancer執行個體的服務地址。	42.XX.XX.6
SlaveZoneId	string	傳統型Server Load Balancer執行個體的備可用性區域 ID。	cn-hangzhou-d
EndTimeStamp	integer	傳統型Server Load Balancer執行個體結束時間戳記。	3249380160000
MasterZoneId	string	傳統型Server Load Balancer執行個體的主可用性區域 ID。	cn-hangzhou-b
LoadBalancerSpec	string	傳統型Server Load Balancer執行個體的效能規格。說明按使用量計費的執行個體無效能規格屬性，預設返回 slb.lcu.elastic。	slb.s1.small
AutoReleaseTime	integer	釋放時間的時間戳記。	1513947075000
ModificationProtectionReason	string	設定修改保護狀態的原因，長度為 1~80 個字元，必須以字母或中文開頭，支援數字、半形句號（.）、底線（_）和短劃線（-）。說明僅在 ModificationProtectionStatus 為 ConsoleProtection 時有效。	Instance service guarantee period
RegionId	string	傳統型Server Load Balancer執行個體所在地區 ID。	cn-hangzhou
ModificationProtectionStatus	string	傳統型負載平衡修改保護狀態： NonProtection：不限制修改保護，設定後會清空之前設定的 ModificationProtectionReason。 ConsoleProtection：執行個體控制台修改保護狀態。說明當取值為 ConsoleProtection，即開啟修改保護後，使用者不能通過負載平衡控制台修改執行個體配置，但可以通過調用 API 修改執行個體配置。	ConsoleProtection
EndTime	string	傳統型Server Load Balancer執行個體結束時間。	2022-09-08T16:00:00Z
VSwitchId	string	私網執行個體的交換器 ID。	vsw-255ecrwq5****
LoadBalancerStatus	string	傳統型Server Load Balancer執行個體狀態： inactive：執行個體已停止，此狀態的執行個體監聽不會再轉寄流量。 active：執行個體運行中，執行個體建立後，預設狀態為 active。 locked：執行個體鎖定，執行個體已經欠費或被阿里雲鎖定。	active
ResourceGroupId	string	企業資源組 ID。	rg-atstuj3rtop****
InternetChargeType	string	公網類型執行個體付費方式。取值： paybytraffic：按使用流量計費。 paybybandwidth：按固定頻寬計費。	paybytraffic
DeleteProtection	string	是否開啟執行個體刪除保護。取值：on 或 off。	off
RegionIdAlias	string	傳統型Server Load Balancer執行個體所屬的地區別名。	cn-hangzhou
RenewalStatus	string	續約狀態，取值： AutoRenewal：自動續約。 Normal：非自動續約，您需要自行續約Server Load Balancer執行個體。 NotRenewal：不再續約。返回該值後，系統不再發送到期提醒，只在到期前第三天發送不續約提醒。說明該參數僅適用於中國站訂用帳戶執行個體，即 PayType 的參數值為 PrePay 時有效。	AutoRenewal
RenewalDuration	integer	自動續約時間長度，僅在 RenewalStatus 為 AutoRenewal 時有效。 RenewalCycUnit 為 Year 時，取值：1~5。 RenewalCycUnit 為 Month 時，取值：1~9。說明該參數僅適用於中國站訂用帳戶執行個體，即 PayType 的參數值為 PrePay 時有效。	1
ListenerPorts	object
ListenerPort	array	傳統型Server Load Balancer執行個體前端使用的連接埠。
	integer	傳統型Server Load Balancer執行個體前端使用的連接埠。	80
ListenerPortsAndProtocal	object
ListenerPortAndProtocal	array<object>	監聽連接埠或協議。
	object	傳統型Server Load Balancer執行個體前端使用的協議。
ListenerProtocal	string	傳統型Server Load Balancer執行個體前端使用的協議。	http
ListenerPort	integer	執行個體前端使用的連接埠。	443
ListenerPortsAndProtocol	object
ListenerPortAndProtocol	array<object>	執行個體前端使用的連接埠和協議。
	object	執行個體前端使用的連接埠和協議。
ListenerPort	integer	執行個體前端使用的連接埠。	80
ListenerProtocol	string	執行個體前端使用的協議。	https
ListenerForward	string	是否啟用監聽轉寄。	on
Description	string	監聽連接埠和協議描述。	The description of listener port and protocol.
ForwardPort	integer	轉寄到的目的監聽連接埠，必須是已經存在的 HTTPS 監聽連接埠。	443
BackendServers	object
BackendServer	array<object>	執行個體的後端伺服器列表。
	object	執行個體的後端伺服器列表。
Type	string	後端伺服器類型。 ecs：ECS 執行個體（預設）。 eni：彈性網卡執行個體。 eci：Elastic Container Instance。	ecs
Weight	integer	後端伺服器的權重。	90
Description	string	後端伺服器描述。說明若使用者未設定 Description，則該參數不返回。	Backend servers
ServerIp	string	ENI 或 ECI 的執行個體 ID。	192.XX.XX.11
ServerId	string	後端伺服器執行個體 ID。	i-2zej4lxhjoq1icu*****
InstanceChargeType	string	執行個體計費方式。取值： PayBySpec：按規格計費。 PayByCLCU：按使用量計費。	PayBySpec

樣本

正常返回樣本

JSON格式

{
  "VpcId": "vpc-25dvzy9f8****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "test",
        "TagValue": "value"
      }
    ]
  },
  "CreateTimeStamp": 1504147745000,
  "CreateTime": "2017-08-31T02:49:05Z",
  "LoadBalancerId": "lb-bp1b6c719dfa08ex****",
  "PayType": "PayOnDemand",
  "AddressType": "internet",
  "NetworkType": "vpc",
  "AddressIPVersion": "ipv4",
  "RenewalCycUnit": "Month",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "Bandwidth": 5,
  "LoadBalancerName": "lb-instance-test",
  "Address": "42.XX.XX.6",
  "SlaveZoneId": "cn-hangzhou-d",
  "EndTimeStamp": 3249380160000,
  "MasterZoneId": "cn-hangzhou-b",
  "LoadBalancerSpec": "slb.s1.small",
  "AutoReleaseTime": 1513947075000,
  "ModificationProtectionReason": "Instance service guarantee period",
  "RegionId": "cn-hangzhou",
  "ModificationProtectionStatus": "ConsoleProtection",
  "EndTime": "2022-09-08T16:00:00Z",
  "VSwitchId": "vsw-255ecrwq5****",
  "LoadBalancerStatus": "active",
  "ResourceGroupId": "rg-atstuj3rtop****",
  "InternetChargeType": "paybytraffic",
  "DeleteProtection": "off",
  "RegionIdAlias": "cn-hangzhou",
  "RenewalStatus": "AutoRenewal",
  "RenewalDuration": 1,
  "ListenerPorts": {
    "ListenerPort": [
      80
    ]
  },
  "ListenerPortsAndProtocal": {
    "ListenerPortAndProtocal": [
      {
        "ListenerProtocal": "http",
        "ListenerPort": 443
      }
    ]
  },
  "ListenerPortsAndProtocol": {
    "ListenerPortAndProtocol": [
      {
        "ListenerPort": 80,
        "ListenerProtocol": "https",
        "ListenerForward": "on",
        "Description": "The description of listener port and protocol.",
        "ForwardPort": 443
      }
    ]
  },
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 90,
        "Description": "Backend servers",
        "ServerIp": "192.XX.XX.11",
        "ServerId": "i-2zej4lxhjoq1icu*****"
      }
    ]
  },
  "InstanceChargeType": "PayBySpec"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	LocationServiceTimeout	Location service connection timeout. Please try again later.
403	UnauthorizedRegion	The specified region of is not authorized.	指定地區不可見。

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

變更歷史

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