Gunakan CreateVpcEndpoint untuk membuat endpoint VPC - PrivateLink - Alibaba Cloud - PrivateLink

Membuat Titik akhir.

Deskripsi operasi

CreateVpcEndpoint adalah operasi asinkron. Setelah Anda memanggil operasi ini, sistem akan mengembalikan ID instans sementara Titik akhir masih dibuat sebagai node latar belakang. Anda dapat memanggil GetVpcEndpointAttribute untuk mengkueri status pembuatan Titik akhir:

Jika Titik akhir berada dalam status Creating, Titik akhir sedang dibuat.
Jika Titik akhir berada dalam status Active, Titik akhir telah dibuat.

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:CreateVpcEndpoint

create

*VpcEndpoint

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

*SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

privatelink:VpcEndpointServiceId

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah Titik akhir. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-huhehaote
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token hanya dapat berisi karakter ASCII.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Apakah akan menjalankan dry run saja, tanpa menjalankan permintaan aktual. Nilai valid: true: Hanya menjalankan dry run. Sistem memeriksa permintaan untuk potensi masalah, termasuk nilai parameter yang hilang, format permintaan yang salah, dan batas layanan. Jika permintaan gagal dalam dry run, kode kesalahan akan dikembalikan. Jika permintaan berhasil dalam dry run, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): Mengirim permintaan normal, melewati dry run, dan mengembalikan kode status HTTP 2xx. Sistem melanjutkan untuk membuat Titik akhir.	false
EndpointName	string	No	Nama Titik akhir. Nama harus memiliki panjang 2 hingga 128 karakter, dan dapat berisi huruf, angka, tanda hubung (-), dan garis bawah (_). Nama harus diawali dengan huruf.	test
EndpointType	string	No	Tipe Titik akhir. Nilai valid: Interface: interface Titik akhir. Anda dapat menambahkan Application Load Balancer (ALB), Classic Load Balancer (CLB), dan Network Load Balancer (NLB) sebagai tipe Sumber daya EPS. Reverse: reverse Titik akhir. Anda dapat menambahkan VPC NAT gerbang sebagai Sumber daya layanan. GatewayLoadBalancer: Gateway Load Balancer Titik akhir (GWLBe). Anda dapat menambahkan Gateway Load Balancer (GWLB) sebagai Sumber daya layanan. Catatan Layanan yang mendukung reverse Titik akhir hanya dapat disediakan oleh Alibaba Cloud dan mitra ekosistem. Secara default, Anda tidak dapat membuat reverse Titik akhir sendiri. Untuk membuat reverse Titik akhir, hubungi manajer akun Anda.	Interface
ZonePrivateIpAddressCount	integer	No	Jumlah alamat IP privat per ENI Titik akhir di setiap zona. Atur nilai menjadi 1.	1
EndpointDescription	string	No	Deskripsi Titik akhir. Deskripsi harus memiliki panjang 2 hingga 256 karakter dan tidak dapat diawali dengan `http://` atau `https://`.	This is my Endpoint.
VpcId	string	Yes	ID virtual private cloud (VPC) tempat Titik akhir berada.	vpc-hp356stwkxg3fn2xe****
ServiceId	string	No	ID layanan titik akhir yang dikaitkan dengan endpoint.	epsrv-hp3xdsq46ael67lo****
ServiceName	string	No	Nama layanan titik akhir yang dikaitkan dengan endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
Zone	array<object>	No	Zona Titik akhir.
	object	No	ID zona di wilayah saat ini. Sistem membuat Sumber daya di zona yang ditentukan.
VSwitchId	string	No	ID vSwitch di zona tempat Anda ingin membuat antarmuka jaringan (ENI) Titik akhir. Anda dapat mengonfigurasi hingga 10 vSwitch.	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	No	Zona Titik akhir. Anda dapat menentukan hingga 10 zona.	cn-huhehaote-b
ip	string	No	Alamat IPv4 ENI di zona Titik akhir yang ditentukan.	192.168.XX.XX
Ipv6Address	string	No	Alamat IPv6 ENI di zona Titik akhir yang ditentukan. Catatan Parameter ini hanya dapat ditentukan jika parameter AddressIpVersion diatur ke DualStack.	2408:4005:34d:**:a58b:62a3:6b55:**
SecurityGroupId	array	No	Kelompok keamanan yang dikaitkan dengan antarmuka jaringan (ENI) Titik akhir.	sg-hp33bw6ynvm2yb0e****
	string	No	Kelompok keamanan yang dikaitkan dengan antarmuka jaringan (ENI) Titik akhir. Kelompok keamanan mengontrol komunikasi data antara VPC dan ENI Titik akhir.	sg-bp1fg655nh68xyz9****
ProtectedEnabled	boolean	No	Apakah akan mengaktifkan perlindungan terkelola. Parameter ini hanya berlaku untuk panggilan berbasis STS. Nilai valid: true: Mengaktifkan perlindungan terkelola. Setelah perlindungan terkelola diaktifkan, hanya pengguna yang sama yang membuat Titik akhir yang dapat memodifikasi atau menghapus Titik akhir menggunakan STS. false (default): Tidak mengaktifkan perlindungan terkelola.	false
RegionId	string	Yes	ID wilayah Titik akhir. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-huhehaote
Tag	array<object>	No	Tag.
	object	No	Tag.
Key	string	No	Kunci tag.	env
Value	string	No	Nilai tag.	prod
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmy*****
PolicyDocument	string	No	Kebijakan akses RAM. Untuk informasi lebih lanjut tentang Definisi kebijakan, lihat Elemen dasar kebijakan.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "oss:List", "oss:PutObject", "oss:GetObject" ], "Resource": [ "acs:oss:oss-::pvl-policy-test/policy-test.txt" ], "Principal": { "RAM": [ "acs:ram::14199xxxxxx:" ] } } ] }
AddressIpVersion	string	No	Versi protokol. Nilai valid: IPv4: IPv4 (default). DualStack: dual-stack. Catatan Untuk menggunakan dual-stack pada endpoint, layanan titik akhir yang terhubung ke endpoint dan VPC tempat endpoint berada harus sama-sama mendukung dual-stack.	IPv4
ZoneAffinityEnabled	boolean	No	Apakah akan mengaktifkan afinitas zona untuk Nama domain Titik akhir dari layanan yang terhubung. Nilai valid: true: Diaktifkan. false (default): Dinonaktifkan.	false
ServiceRegionId	string	No	ID wilayah layanan titik akhir. Nilai default adalah wilayah saat ini tempat Anda membuat endpoint.	cn-huhehaote
CrossRegionBandwidth	integer	No	Bandwidth lintas wilayah. Parameter ini hanya diperlukan jika Titik akhir dan layanan titik akhir berada di wilayah yang berbeda. Unit: Mbps. Nilai valid: Nilai default: 1000 untuk koneksi lintas wilayah di Tiongkok daratan. 100 untuk skenario lainnya. Nilai minimum: 100. Nilai maksimum: tergantung pada Kuota akun Anda. Untuk informasi lebih lanjut, lihat Kuota dan batas. Catatan Tentukan parameter ini hanya saat Anda membuat Titik akhir lintas wilayah.	1000

Elemen respons

Element	Type	Description	Example
	object
EndpointDomain	string	Nama domain Titik akhir.	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
RequestId	string	ID permintaan.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
CreateTime	string	Waktu pembuatan Titik akhir.	2022-01-02T19:11:12Z
EndpointBusinessStatus	string	Status bisnis Titik akhir. Nilai valid: Normal: Normal. FinancialLocked: terkunci karena Pembayaran tertunda.	Normal
EndpointDescription	string	Deskripsi Titik akhir.	This is my Endpoint.
ServiceId	string	ID layanan titik akhir yang dikaitkan dengan endpoint.	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	Status Titik akhir. Nilai valid: Creating: sedang dibuat. Active: tersedia. Pending: sedang dimodifikasi. Deleting: sedang dihapus.	Active
VpcId	string	ID virtual private cloud (VPC) tempat Titik akhir berada.	vpc-hp356stwkxg3fn2xe****
EndpointName	string	Nama Titik akhir.	test
ServiceName	string	Nama layanan titik akhir yang dikaitkan dengan endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	Bandwidth koneksi Titik akhir. Unit: Mbps.	200
EndpointId	string	ID Titik akhir.	ep-hp33b2e43fays7s8****
ConnectionStatus	string	Status Koneksi titik akhir. Nilai valid: Pending: sedang dimodifikasi. Connecting: sedang menghubungkan. Connected: terhubung. Disconnecting: sedang memutuskan. Disconnected: terputus. Deleting: sedang dihapus.	Disconnected
AddressIpVersion	string	Versi protokol. Nilai valid: IPv4: IPv4 (default). DualStack: dual-stack.	IPv4
ZoneAffinityEnabled	boolean	Apakah afinitas zona diaktifkan untuk Nama domain Titik akhir dari layanan yang terhubung. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	false
ServiceRegionId	string	ID wilayah layanan titik akhir.	cn-huhehaote
CrossRegionBandwidth	integer	Bandwidth lintas wilayah endpoint. Parameter ini hanya dikembalikan jika endpoint dan layanan titik akhir berada di wilayah yang berbeda. Unit: Mbps.	1000

Contoh

Respons sukses

JSONformat

{
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "CreateTime": "2022-01-02T19:11:12Z",
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "This is my Endpoint.",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-hp356stwkxg3fn2xe****",
  "EndpointName": "test",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 200,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "ConnectionStatus": "Disconnected",
  "AddressIpVersion": "IPv4",
  "ZoneAffinityEnabled": false,
  "ServiceRegionId": "cn-huhehaote",
  "CrossRegionBandwidth": 1000
}

Kode kesalahan

HTTP status code	Error code	Error message
400	EndpointExist	The specified Endpoint already exists.
400	EndpointZoneDuplicated	The zone is duplicated for the Endpoint.
400	EndpointServiceNotFound	The specified Service does not exist.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	SecurityGroupNotFound	The specified security group does not exist.
400	VpcTunnelNotFound	The specified VPC tunnel does not exist.
400	VpcNotFound	The specified VPC does not exist.
400	GenerateResourceIdFailed	Failed to generate ResourceId.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.
400	EndpointMustContainSecurityGroup	The specified endpoint must have at least one security group.
400	EndpointDuplicated	The endpoint of the service already exists and cannot be created again.
400	EndpointServiceDeleted	The specified Service is already deleted.
400	EndpointServiceResourceNotFound	The specified service resource is not found.
400	SecurityGroupTypeNotSupport	The specified security group type is not supported.
400	EniIpUnavailable	The specified IP address is unavailable.
400	EndpointServiceNotAuthorized	The specified endpoint service is not authorized to user.
400	SecurityGroupTypeOnlySingleTypeSupporteded	The specified security group only support one type.
400	QuotaExceeded.IpQuotaPerEp	The quota of %s is exceeded, usage %s/%s.
400	Mismatch.EndpointType	The %s is mismatched for %s and %s.
400	IncorrectStatus.VpcEndpointService	The status of %s [%s] is incorrect.
400	CheckServiceLinkRoleError	The ServiceLink role check error.
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.
400	VSwitchStatusNotAllowed	The specified vswitch status is not Available.
400	QuotaExceeded.epZonePerEndpoint	The quota of %s is exceeded, usage %s/%s.
400	QuotaExceeded.totalEpPerVpc	The quota of %s is exceeded, usage %s/%s.
400	QuotaExceeded.totalIdleEndpoint	The quota of %s is exceeded, usage %s/%s.
400	OperationDenied.EndpointPolicyNotSupport	The operation is not allowed because of EndpointPolicyNotSupport.
400	OperationDenied.PrivateDomainStatusNotSupport	The operation is not allowed because of %s.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.
400	GatewayLoadBalancerNotSupportSecurityGroup	The gateway load balancer not support security group.
400	GatewayLoadBalancerZoneCountDeny	The GatewayLoadBalancer zone count not support
400	OperationDenied.EndpointTypeNotSupportDualstack	The specified endpoint type does not support dualstack, only the Interface and GatewayLoadBalancer types support dual stack.
400	OperationDenied.EndpointServiceNotSupportDualstack	The specified endpoint service does not support dualstack.
400	OperationDenied.VSwitchNotSupportDualstack	The specified VSwitch does not support dualstack.
400	OperationDenied.AddressIpVersionNotSupportSpecifyIpv6	The AddressIpVersion of the endpoint does not support specifying IPv6 address.
400	IllegalParam.Ip	The specified parameter IP is invalid.
400	IllegalParam.Ipv6Address	The specified parameter Ipv6Address is invalid.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.