GetVpcEndpointServiceAttribute - 擷取終端節點服務屬性資訊 - PrivateLink

調用GetVpcEndpointServiceAttribute介面，擷取終端節點服務屬性資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

privatelink:GetVpcEndpointServiceAttribute

get

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	終端節點服務所屬的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-huhehaote
ServiceId	string	是	終端節點服務的 ID。	epsrv-hp3vpx8yqxblby3i****
RegionId	string	是	終端節點服務所屬的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-huhehaote

返回參數

名稱	類型	描述	樣本值
	object
Payer	string	付費方，取值： Endpoint：服務使用方。 EndpointService：服務提供者。	Endpoint
RequestId	string	請求 ID。	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceDescription	string	終端節點服務的描述資訊。	This is my EndpointService.
CreateTime	string	終端節點服務的建立時間。	2020-01-02T19:11:12Z
MaxBandwidth	integer	終端節點串連的最大頻寬。單位：Mbps。	1024
MinBandwidth	integer	終端節點串連的最小頻寬。單位：Mbps。	100
ServiceDomain	string	終端節點服務的服務網域名稱。	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
AutoAcceptEnabled	boolean	是否自動接受終端節點串連，取值： true：自動接受終端節點串連。 false：不自動接受終端節點串連。	true
ZoneAffinityEnabled	boolean	是否支援串連服務的終端節點網域名稱就近解析。取值： true（預設值）：是。 false：否。	true
ServiceId	string	終端節點服務的 ID。	epsrv-hp3vpx8yqxblby3i****
Zones	array	服務資源所屬的可用性區域列表。
	string	服務資源所屬的可用性區域。	cn-huhehaote-b
ServiceBusinessStatus	string	終端節點服務的業務狀態，取值： Normal：正常。 FinancialLocked：欠費鎖定。	Normal
ServiceName	string	終端節點服務的名稱。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	終端節點服務的狀態，取值： Creating：建立中。 Pending：修改中。 Active：可用。 Deleting：刪除中。	Active
ConnectBandwidth	integer	預設串連頻寬峰值。單位：Mbps。取值範圍：100~10240。	3072
RegionId	string	終端節點服務所屬的地區。	cn-huhehaote
ServiceType	string	終端節點類型。 Interface：表示介面終端節點，您可以添加傳統型負載平衡 CLB（Classic Load Balancer）、應用型負載平衡 ALB（Application Load Balancer）和網路型負載平衡 NLB（Network Load Balancer ）的服務資源類型。 GatewayLoadBalancer：表示網關型負載平衡終端節點，您可以添加網關型負載平衡 GWLB（Gateway Load Balancer）作為服務資源。	Interface
ServiceResourceType	string	服務資源類型，取值： slb：表示服務資源類型為傳統型負載平衡 CLB（Classic Load Balancer）。 alb：表示服務資源類型為應用型負載平衡 ALB（Application Load Balancer）。 nlb ：表示服務資源類型為網路型負載平衡 NLB（Network Load Balancer ）。 gwlb : 表示服務資源類型為網關型負載平衡 GWLB（Gateway Load Balancer）。	slb
ServiceSupportIPv6 `deprecated`	boolean	終端節點服務是否支援 IPv6 功能。取值： true：是。 false（預設值）：否。	false
ResourceGroupId	string	資源群組 ID。	rg-acfmy*****
AddressIpVersion	string	協議版本。取值： IPv4：IPv4 類型。 DualStack：雙棧類型。	IPv4
SupportedRegionSet	array<object>
	object
ServiceRegionId	string
RegionServiceStatus	string
RegionBusinessStatus	string

樣本

正常返回樣本

JSON格式

{
  "Payer": "Endpoint",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceDescription": "This is my EndpointService.",
  "CreateTime": "2020-01-02T19:11:12Z",
  "MaxBandwidth": 1024,
  "MinBandwidth": 100,
  "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "AutoAcceptEnabled": true,
  "ZoneAffinityEnabled": true,
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "Zones": [
    "cn-huhehaote-b"
  ],
  "ServiceBusinessStatus": "Normal",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus": "Active",
  "ConnectBandwidth": 3072,
  "RegionId": "cn-huhehaote",
  "ServiceType": "Interface",
  "ServiceResourceType": "slb",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****",
  "AddressIpVersion": "IPv4",
  "SupportedRegionSet": [
    {
      "ServiceRegionId": "",
      "RegionServiceStatus": "",
      "RegionBusinessStatus": ""
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	EndpointServiceNotFound	The specified Service does not exist.	當前終端節點服務不存在

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

變更歷史

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