CreateVpcEndpoint - PrivateLink

Membuat endpoint.

Deskripsi operasi

CreateVpcEndpoint adalah operasi asinkron. Setelah Anda mengirim permintaan, sistem akan mengembalikan ID instans dan membuat titik akhir di latar belakang. Anda dapat memanggil operasi GetVpcEndpointAttribute untuk memeriksa 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 tersedia.

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 dari titik akhir. Panggil operasi DescribeRegions untuk mendapatkan ID wilayah.	cn-huhehaote
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Buat nilai untuk parameter ini dari klien Anda agar permintaan bersifat idempoten. Parameter ClientToken hanya mendukung karakter ASCII.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Menentukan apakah akan melakukan dry run. Nilai yang valid: true: melakukan dry run. Sistem memeriksa parameter yang diperlukan, format permintaan, dan batas layanan. Jika permintaan gagal dalam dry run, kesalahan akan dikembalikan. Jika permintaan lolos dry run, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): mengirim permintaan normal. Jika permintaan lolos pemeriksaan, kode status HTTP 2xx dikembalikan dan operasi dilakukan.	false
EndpointName	string	No	Nama titik akhir. Nama harus terdiri dari 2 hingga 128 karakter, dimulai dengan huruf, dan dapat berisi angka, tanda hubung (-), serta garis bawah (_).	test
EndpointType	string	No	Tipe titik akhir. Nilai yang valid: Interface: titik akhir antarmuka. Anda dapat menambahkan instans Application Load Balancer (ALB), Classic Load Balancer (CLB), dan Network Load Balancer (NLB) sebagai sumber daya layanan. Reverse: titik akhir balik. Anda dapat menambahkan VPC NAT Gateway sebagai sumber daya layanan. GatewayLoadBalancer: titik akhir Gateway Load Balancer (GWLB). Anda dapat menambahkan instans GWLB sebagai sumber daya layanan. Catatan Layanan yang mendukung titik akhir balik hanya disediakan oleh Alibaba Cloud dan mitra ekosistemnya. Anda tidak dapat membuat layanan ini secara default. Untuk membuat layanan tersebut, hubungi manajer akun Anda.	Interface
ZonePrivateIpAddressCount	integer	No	Jumlah alamat IP pribadi yang dapat dibuat untuk endpoint elastic network interface (ENI) di setiap zona. Tetapkan nilainya ke 1.	1
EndpointDescription	string	No	Deskripsi titik akhir. Deskripsi harus terdiri dari 2 hingga 256 karakter dan tidak boleh dimulai dengan `http://` atau `https://`.	This is my Endpoint.
VpcId	string	Yes	ID virtual private cloud (VPC) tempat titik akhir dibuat.	vpc-hp356stwkxg3fn2xe****
ServiceId	string	No	ID layanan titik akhir yang terkait dengan titik akhir.	epsrv-hp3xdsq46ael67lo****
ServiceName	string	No	Nama layanan titik akhir yang terkait dengan titik akhir.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
Zone	array<object>	No	Zona tempat titik akhir akan dibuat.
	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 ENI titik akhir. Anda dapat menentukan hingga 10 ID vSwitch.	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	No	ID zona yang didukung oleh layanan titik akhir. Anda dapat menentukan hingga 10 ID zona.	cn-huhehaote-b
ip	string	No	Alamat IP titik akhir di zona yang ditentukan.	192.168.XX.XX
Ipv6Address	string	No	Alamat IPv6 titik akhir di zona yang ditentukan. Catatan Parameter ini hanya tersedia ketika Anda menetapkan parameter AddressIpVersion ke DualStack.	2408:4005:34d:**:a58b:62a3:6b55:**
SecurityGroupId	array	No	ID grup keamanan yang terkait dengan ENI titik akhir.	sg-hp33bw6ynvm2yb0e****
	string	No	ID grup keamanan tempat ENI titik akhir berada. Grup keamanan ini mengontrol komunikasi data dari VPC ke ENI titik akhir.	sg-bp1fg655nh68xyz9****
ProtectedEnabled	boolean	No	Menentukan apakah akan mengaktifkan perlindungan terkelola. Parameter ini hanya berlaku ketika Anda mengasumsikan peran RAM untuk melakukan operasi. Nilai yang valid: true: mengaktifkan perlindungan terkelola. Setelah diaktifkan, hanya pengguna yang membuat titik akhir yang dapat memodifikasi atau menghapus titik akhir menggunakan token Security Token Service (STS). false (default): menonaktifkan perlindungan terkelola.	false
RegionId	string	Yes	ID wilayah dari titik akhir. Panggil operasi DescribeRegions untuk mendapatkan ID wilayah.	cn-huhehaote
Tag	array<object>	No	Tag sumber daya.
	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 sintaks 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 IP. Nilai yang valid: IPv4 (default) DualStack Catatan Untuk menggunakan fitur dual-stack, aktifkan fitur tersebut untuk layanan titik akhir terkait dan VPC tempat titik akhir dibuat. Valid values: IPv4 : IPv4 DualStack : DualStack	IPv4
ZoneAffinityEnabled	boolean	No	Menentukan apakah akan mengaktifkan afinitas zona. Jika Anda mengaktifkan afinitas zona, permintaan akan diarahkan ke titik akhir di zona yang sama dengan klien. Nilai yang valid: true false (default)	false

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 saat titik akhir dibuat.	2022-01-02T19:11:12Z
EndpointBusinessStatus	string	Status bisnis titik akhir. Nilai yang valid: Normal: Titik akhir berjalan sebagaimana mestinya. FinancialLocked: Titik akhir dikunci karena pembayaran tertunda.	Normal
EndpointDescription	string	Deskripsi titik akhir.	This is my Endpoint.
ServiceId	string	ID layanan titik akhir yang terkait dengan titik akhir.	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	Status titik akhir. Nilai yang valid: Creating Active Pending Deleting	Active
VpcId	string	ID VPC tempat titik akhir berada.	vpc-hp356stwkxg3fn2xe****
EndpointName	string	Nama titik akhir.	test
ServiceName	string	Nama layanan titik akhir yang terkait dengan titik akhir.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	Bandwidth koneksi titik akhir, dalam Mbit/s.	200
EndpointId	string	ID titik akhir.	ep-hp33b2e43fays7s8****
ConnectionStatus	string	Status koneksi titik akhir. Nilai yang valid: Pending Connecting Connected Disconnecting Disconnected Deleting	Disconnected
AddressIpVersion	string	Versi IP. Nilai yang valid: IPv4 (default) DualStack	IPv4
ZoneAffinityEnabled	boolean	Menunjukkan apakah afinitas zona diaktifkan. Nilai yang valid: true false	false
ServiceRegionId	string
CrossRegionBandwidth	integer

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": "",
  "CrossRegionBandwidth": 0
}

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.