Gunakan ListVpcEndpoints untuk mengambil endpoint VPC - PrivateLink - Alibaba Cloud - PrivateLink

Operasi `ListVpcEndpoints` membuat daftar titik akhir.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

privatelink:ListVpcEndpoints

get

*VpcEndpoint

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah tempat titik akhir di-deploy. Anda dapat memanggil operasi DescribeRegions untuk mendapatkan ID wilayah.	cn-huhehaote
NextToken	string	No	Token yang digunakan untuk mengambil halaman hasil berikutnya. Jika ini adalah kueri pertama Anda atau tidak ada halaman berikutnya, Anda tidak perlu menentukan parameter ini. Jika halaman berikutnya tersedia, tetapkan nilainya ke nilai NextToken yang dikembalikan dari panggilan sebelumnya.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai valid: 1 hingga 1000. Nilai default: 50.	50
EndpointId	string	No	ID titik akhir.	ep-hp33b2e43fays7s8****
ServiceName	string	No	Nama layanan titik akhir yang terkait dengan titik akhir.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
VpcId	string	No	ID VPC tempat titik akhir berada.	vpc-fdjkf789dfdfdfde****
EndpointName	string	No	Nama titik akhir.	test
EndpointType	string	No	Tipe titik akhir. Nilai valid: Interface: titik akhir antarmuka Reverse: titik akhir reverse GatewayLoadBalancer: titik akhir tipe Gateway Load Balancer.	Interface
EndpointStatus	string	No	Status titik akhir. Nilai valid: Creating: Titik akhir sedang dibuat. Active: Titik akhir tersedia. Pending: Titik akhir sedang dimodifikasi. Deleting: Titik akhir sedang dihapus.	Active
ConnectionStatus	string	No	Status koneksi titik akhir. Nilai valid: Pending: Koneksi titik akhir sedang dimodifikasi. Connecting: Titik akhir sedang terhubung. Connected: Titik akhir telah terhubung. Disconnecting: Titik akhir sedang memutus koneksi. Disconnected: Titik akhir telah terputus. Deleting: Titik akhir sedang dihapus. ServiceDeleted: Layanan titik akhir yang terkait dengan titik akhir telah dihapus.	Disconnected
Tag	array<object>	No	Tag.
	object	No	A tag that consists of a key-value pair.
Key	string	No	The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua
RegionId	string	Yes	The ID of the region where the endpoint is deployed. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
ResourceGroupId	string	No	ID kelompok sumber daya.	1
AddressIpVersion	string	No	Versi IP. Nilai valid: IPv4: IPv4 DualStack: dual stack.	IPv4
ServiceRegionId	string	No	ID wilayah tempat layanan titik akhir di-deploy.	cn-huhehaote

Elemen respons

Element	Type	Description	Example
	object
Endpoints	array<object>	A list of endpoints.
	array<object>
VpcId	string	The ID of the VPC to which the endpoint belongs.	vpc-hp356stwkxg3fn2xe****
EndpointName	string	The name of the endpoint.	test
EndpointType	string	The type of the endpoint. Valid values: Interface: an interface endpoint. Reverse: a reverse endpoint. GatewayLoadBalancer: a gateway load balancer endpoint.	Interface
CreateTime	string	The time when the endpoint was created.	2021-09-24T18:00:07Z
ServiceId	string	The ID of the associated endpoint service.	epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabled	boolean	Indicates whether zone-aware DNS resolution is enabled. Valid values: true false	true
EndpointDomain	string	The domain name of the endpoint.	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
EndpointStatus	string	The status of the endpoint. Valid values: Creating: The endpoint is being created. Active: The endpoint is available. Pending: The endpoint is being modified. Deleting: The endpoint is being deleted.	Active
RegionId	string	The ID of the region that contains the endpoint.	cn-huhehaote
ResourceOwner	boolean	Indicates whether the endpoint and the endpoint service belong to the same Alibaba Cloud account. Valid values: true false	true
Bandwidth	integer	The connection bandwidth of the endpoint, in Mbps.	1024
ConnectionStatus	string	The connection status of the endpoint. Valid values: Pending: The connection is being modified. Connecting: The endpoint is being connected. Connected: The endpoint is connected. Disconnecting: The endpoint is being disconnected. Disconnected: The endpoint is disconnected. Deleting: The endpoint is being deleted. ServiceDeleted: The associated endpoint service has been deleted.	Disconnected
EndpointDescription	string	The description of the endpoint.	This is my Endpoint.
EndpointId	string	The ID of the endpoint.	ep-hp33b2e43fays7s8****
EndpointBusinessStatus	string	The business status of the endpoint. Valid values: Normal: The endpoint is running as expected. FinancialLocked: The endpoint is locked due to an overdue payment.	Normal
ServiceName	string	The name of the associated endpoint service.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Tags	array<object>	A list of tags.
	object
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
ResourceGroupId	string	The ID of the resource group.	1
PolicyDocument	string	The RAM access policy. For details on the policy syntax, see Basic elements of a RAM policy.	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
AddressIpVersion	string	The IP address family. Valid values: IPv4: IPv4. DualStack: dual stack.	IPv4
ServiceRegionId	string	The ID of the region where the associated endpoint service is deployed.	cn-huhehaote
CrossRegionBandwidth	integer	The bandwidth of the cross-region connection, in Mbps.	1000
NextToken	string	The token to retrieve the next page of results. If NextToken is empty, no next page exists. If a value is returned, use it in your next request to retrieve the next page of results.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries returned per page.	50
TotalCount	integer	The total number of entries that match the query.	12

Contoh

Respons sukses

JSONformat

{
  "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
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.