ListVpcGatewayEndpoints - 查詢VPC網關端點列表 - Virtual Private Cloud

調用ListVpcGatewayEndpoints介面查詢已建立的網關終端節點的列表。

調試

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

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
EndpointId	string	否	網關終端節點執行個體 ID。	vpce-bp1i1212ss2whuwyw****
EndpointName	string	否	網關終端節點的名稱。名稱的長度在 1~128 個字元之間。	test
ServiceName	string	否	終端節點服務名稱。	com.aliyun.cn-hangzhou.oss
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查詢時每次顯示的條目數。取值範圍：1~100，預設值為 20。	20
RegionId	string	是	要查詢的網關終端節點所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
ResourceGroupId	string	否	網關終端節點所屬的資源群組 ID。	rg-acfmxvfvazb4p****
Tags	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。一個標籤鍵最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceJoshua
VpcId	string	否	網關終端節點所屬的 VPC ID。	vpc-bp1gsk7h12ew7oegk****

返回參數

名稱	類型	描述	樣本值
	object	請求 ID。
RequestId	string	請求 ID。	0AB1129F-32C1-5E4D-9E22-E4A859CA46EB
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	列表條目數。	10
Endpoints	array<object>	網關終端節點的列表。
	array<object>	網關終端節點的列表。
EndpointId	string	網關終端節點執行個體 ID。	vpce-bp1i1212ss2whuwyw****
EndpointName	string	網關終端節點的名稱。	test
EndpointDescription	string	網關終端節點的描述資訊。	test_description
ServiceName	string	終端節點服務名稱。	com.aliyun.cn-hangzhou.oss
VpcId	string	網關終端節點所在的 VPC ID。	vpc-bp1gsk7h12ew7oegk****
PolicyDocument	string	雲端服務的存取原則。關於存取原則的文法和結構，請參見權限原則文法和結構。	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
CreationTime	string	網關終端節點的建立時間。按照 ISO8601 標準表示，並需要使用 UTC 時間。格式為：YYYY-MM-DDThh:mm:ssZ。	2021-09-08T08:43:04Z
EndpointStatus	string	網關終端節點的狀態。取值： Creating：建立中。 Created：已建立，正常狀態。 Modifying：修改中。 Associating：綁定中。 Dissociating：解除綁定中。 Deleting：刪除中。	Created
AssociatedRouteTables	array	網關終端節點關聯的路由表 ID。
	string	網關終端節點關聯的路由表 ID。	vtb-bp1sme72jnuodvyx7****
ResourceGroupId	string	網關終端節點所屬的資源群組 ID。	rg-acfmxvfvazb4p****
Tags	array<object>	標籤列表。
	object	標籤列表。
Key	string	標籤鍵。	FinanceDept
Value	string	標籤值。	FinanceJoshua
MaxResults	integer	分批次查詢時每次顯示的條目數。	20

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0AB1129F-32C1-5E4D-9E22-E4A859CA46EB",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 10,
  "Endpoints": [
    {
      "EndpointId": "vpce-bp1i1212ss2whuwyw****",
      "EndpointName": "test",
      "EndpointDescription": "test_description",
      "ServiceName": "com.aliyun.cn-hangzhou.oss",
      "VpcId": "vpc-bp1gsk7h12ew7oegk****",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "CreationTime": "2021-09-08T08:43:04Z",
      "EndpointStatus": "Created",
      "AssociatedRouteTables": [
        "vtb-bp1sme72jnuodvyx7****"
      ],
      "ResourceGroupId": "rg-acfmxvfvazb4p****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ],
  "MaxResults": 20
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParam.NextToken	The specified NextToken is invalid.	參數NextToken非法.
400	IllegalParam.MaxResults	The param of MaxResults is illegal.
400	InvalidVpcId.NotFound	Specified value of VpcId is not found in our record.

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

變更歷史

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