調用ListVpcEndpoints查詢終端節點-私網串連-阿里雲 - PrivateLink

呼叫 ListVpcEndpoints 介面，查詢終端節點清單。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

privatelink:ListVpcEndpoints

get

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	要查詢的終端節點所屬的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-huhehaote
NextToken	string	否	是否擁有下一次查詢的權杖（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	否	分頁大小。取值範圍：1~1000。預設值：50。	50
EndpointId	string	否	要查詢的終端節點 ID。	ep-hp33b2e43fays7s8****
ServiceName	string	否	要查詢的終端節點關聯的終端節點服務名稱。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
VpcId	string	否	終端節點所屬的專有網路。	vpc-fdjkf789dfdfdfde****
EndpointName	string	否	終端節點名稱。	test
EndpointType	string	否	終端節點類型。取值： Interface：表示介面終端節點。 Reverse：表示反向終端節點。 GatewayLoadBalancer：表示閘道器型負載平衡終端節點。	Interface
EndpointStatus	string	否	終端節點狀態，取值： Creating：建立中。 Active：可用。 Pending：修改中。 Deleting：刪除中。	Active
ConnectionStatus	string	否	終端節點連線狀態，取值： Pending：修改中。 Connecting：連線中。 Connected：已連線。 Disconnecting：斷開連線中。 Disconnected：未連線。 Deleting：刪除中。 ServiceDeleted：終端節點對應的服務已刪除。	Disconnected
Tag	array<object>	否	標籤清單。
	object	否	標籤。
Key	string	否	執行個體的標籤鍵。最多支援 20 個標籤鍵。一旦傳入該值，則不允許為空字串。最多支援 64 個字元，不能以 `aliyun` 和 `acs:` 開頭，不能包含 `http://` 或者 `https://`。	FinanceDept
Value	string	否	執行個體的標籤值。最多支援 20 個標籤值。一旦傳入該值，可以為空字串。最多支援 128 個字元，不能以 `aliyun` 和 `acs:` 開頭，不能包含 `http://` 或者 `https://`。	FinanceJoshua
ResourceGroupId	string	否	資源群組 ID。	1
AddressIpVersion	string	否	通訊協定版本。取值： IPv4：IPv4 類型。 DualStack：雙堆疊類型。	IPv4
ServiceRegionId	string	否	終端節點服務所屬的地域 ID。	cn-huhehaote

返回參數

名稱	類型	描述	樣本值
	object
Endpoints	array<object>	終端節點資訊集合。
	array<object>	終端節點資訊集合。
VpcId	string	終端節點所屬的專有網路。	vpc-hp356stwkxg3fn2xe****
EndpointName	string	終端節點名稱。	test
EndpointType	string	終端節點類型。取值： Interface：表示介面終端節點。 Reverse：表示反向終端節點。 GatewayLoadBalancer：表示閘道器型負載平衡終端節點。	Interface
CreateTime	string	終端節點的建立時間。	2021-09-24T18:00:07Z
ServiceId	string	終端節點關聯的終端節點服務的 ID。	epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabled	boolean	是否支援連線服務的終端節點網域就近解析。取值： true：是。 false：否。	true
EndpointDomain	string	終端節點網域。	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
EndpointStatus	string	終端節點狀態，取值： Creating：建立中。 Active：可用。 Pending：修改中。 Deleting：刪除中。	Active
RegionId	string	終端節點所屬的地域 ID。	cn-huhehaote
ResourceOwner	boolean	終端節點和終端節點服務是否同一帳號，取值： true：是。 false：否。	true
Bandwidth	integer	終端節點的連線頻寬，單位：Mbps。	1024
ConnectionStatus	string	終端節點連線狀態，取值： Pending：修改中。 Connecting：連線中。 Connected：已連線。 Disconnecting：斷開連線中。 Disconnected：未連線。 Deleting：刪除中。 ServiceDeleted：終端節點對應的服務已刪除。	Disconnected
EndpointDescription	string	終端節點描述。	This is my Endpoint.
EndpointId	string	終端節點 ID。	ep-hp33b2e43fays7s8****
EndpointBusinessStatus	string	終端節點的業務狀態。取值： Normal：正常。 FinancialLocked：欠費鎖定。	Normal
ServiceName	string	終端節點關聯的終端節點服務的名稱。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Tags	array<object>	標籤清單。
	object	標籤清單。
Key	string	執行個體的標籤鍵。	FinanceDept
Value	string	執行個體的標籤值。	FinanceJoshua
ResourceGroupId	string	資源執行個體 ID。	1
PolicyDocument	string	RAM 權限原則。關於原則定義的更多資訊，請參見權限原則基本元素。	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
AddressIpVersion	string	通訊協定版本。取值： IPv4：IPv4 類型。 DualStack：雙堆疊類型。	IPv4
ServiceRegionId	string	終端節點關聯的終端節點服務所屬的地域 ID。	cn-huhehaote
CrossRegionBandwidth	integer	終端節點的跨地域頻寬值。單位：Mbps。	1000
ProtectedEnabled	boolean	是否開啟託管保護，STS 呼叫方式下生效。取值： true：開啟。開啟託管保護後，只有和建立時相同的使用者才能透過 STS 方式對該終端節點進行修改或者刪除等操作。 false：不開啟。
NextToken	string	是否擁有下一次查詢的權杖（Token）。取值：如果 NextToken 為空表示沒有下一次查詢。如果 NextToken 有返回值，該取值表示下一次查詢開始的權杖。	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	請求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	分頁大小。	50
TotalCount	integer	總記錄數。	12

樣本

正常返回樣本

JSON格式

{
  "Endpoints": [
    {
      "VpcId": "vpc-hp356stwkxg3fn2xe****",
      "EndpointName": "test",
      "EndpointType": "Interface",
      "CreateTime": "2021-09-24T18:00:07Z",
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ZoneAffinityEnabled": true,
      "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
      "EndpointStatus": "Active",
      "RegionId": "cn-huhehaote",
      "ResourceOwner": true,
      "Bandwidth": 1024,
      "ConnectionStatus": "Disconnected",
      "EndpointDescription": "This is my Endpoint.",
      "EndpointId": "ep-hp33b2e43fays7s8****",
      "EndpointBusinessStatus": "Normal",
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "1",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "AddressIpVersion": "IPv4",
      "ServiceRegionId": "cn-huhehaote",
      "CrossRegionBandwidth": 1000,
      "ProtectedEnabled": false
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

錯誤碼

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

變更歷史

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