CreateVpcEndpointService - PrivateLink

Membuat layanan titik akhir.

Deskripsi operasi

Sebelum membuat layanan titik akhir, pastikan Anda telah membuat resource load balancing yang mendukung PrivateLink. Untuk informasi selengkapnya, lihat Create an SLB instance.
CreateVpcEndpointService adalah operasi asinkron. Setelah permintaan dikirim, sistem mengembalikan ID instans dan membuat layanan titik akhir di latar belakang. Anda dapat memanggil operasi GetVpcEndpointServiceAttribute untuk mengecek status layanan titik akhir.
- Jika layanan titik akhir berada dalam status Creating, layanan tersebut sedang dalam proses pembuatan.
- Jika layanan titik akhir berada dalam status Active, layanan tersebut telah berhasil 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:CreateVpcEndpointService

create

*VpcEndpointService

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

LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah dari layanan titik akhir. Panggil DescribeRegions untuk mendapatkan ID wilayah.	cn-huhehaote
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Hasilkan nilai dari klien Anda untuk memastikan nilai tersebut unik di antara permintaan yang berbeda. ClientToken hanya dapat berisi 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, pesan kesalahan dikembalikan. Jika permintaan lolos dry run, kode kesalahan `DryRunOperation` dikembalikan. false (default): melakukan dry run dan mengirim permintaan. Jika permintaan lolos dry run, kode status HTTP 2xx dikembalikan dan operasi dipanggil.	false
ServiceDescription	string	No	Deskripsi layanan titik akhir.	This is my EndpointService.
AutoAcceptEnabled	boolean	No	Menentukan apakah koneksi titik akhir diterima secara otomatis. Nilai yang valid: true: menerima koneksi titik akhir secara otomatis. false (default): tidak menerima koneksi titik akhir secara otomatis.	false
Payer	string	No	Pihak yang membayar. Nilai yang valid: Endpoint: konsumen layanan. EndpointService: penyedia layanan.	Endpoint
ZoneAffinityEnabled	boolean	No	Menentukan apakah afinitas zona diaktifkan. Nilai yang valid: true false (default)	false
ServiceResourceType	string	No	Jenis sumber daya layanan. Nilai yang valid: slb: Classic Load Balancer (CLB). alb: Application Load Balancer (ALB). nlb: Network Load Balancer (NLB). gwlb: Gateway Load Balancer (GWLB). Catatan Pendengar NLB dengan tipe TCPSSL tidak didukung.	slb
Resource	array<object>	No	Sumber daya layanan. Anda dapat menambahkan hingga 10 sumber daya layanan saat membuat layanan titik akhir. Setelah layanan titik akhir dibuat, Anda dapat menambahkan lebih banyak sumber daya layanan.
	object	No	Sumber daya layanan.
ResourceType	string	No	Jenis sumber daya layanan. Anda dapat menambahkan hingga 20 sumber daya layanan ke layanan titik akhir. Nilai yang valid: slb: CLB. alb: ALB. nlb: NLB. gwlb: GWLB. Catatan Di wilayah yang mendukung PrivateLink, semua instans CLB dalam virtual private cloud (VPC) dapat digunakan sebagai sumber daya layanan untuk layanan titik akhir.	slb
ResourceId	string	No	ID sumber daya layanan.	lb-hp32z1wp5peaoox2q****
ZoneId	string	No	ID zona.	cn-huhehaote-a
RegionId	string	Yes	ID wilayah dari layanan titik akhir. Panggil DescribeRegions untuk mendapatkan ID wilayah.	cn-huhehaote
ServiceSupportIPv6 `deprecated`	boolean	No	Menentukan apakah layanan titik akhir mendukung IPv6. Nilai yang valid: true false (default)	false
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmy*****
Tag	array<object>	No	Daftar tag.
	object	No	Daftar tag.
Key	string	No	Kunci tag. Anda dapat menentukan hingga 20 kunci tag. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag maksimal 64 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	env
Value	string	No	Nilai tag. Anda dapat menentukan hingga 20 nilai tag. Nilai tag boleh berupa string kosong. Panjang nilai tag maksimal 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Nilai tag tidak boleh mengandung `http://` atau `https://`.	prod
AddressIpVersion	string	No	Versi IP. Nilai yang valid: IPv4 (default) DualStack Catatan Saat ini, hanya layanan titik akhir yang menggunakan instans NLB atau GWLB sebagai sumber daya layanan yang mendukung DualStack. Jika Anda mengatur nilainya ke DualStack, sumber daya layanan juga harus mendukung dual-stack. Valid values: IPv4 : IPv4 DualStack : DualStack	IPv4

Elemen respons

Element	Type	Description	Example
	object
ServiceBusinessStatus	string	Status bisnis layanan titik akhir. Nilai yang valid: Normal: Layanan titik akhir berjalan sebagaimana mestinya. FinancialLocked: Layanan titik akhir terkunci karena pembayaran tertunda.	Normal
RequestId	string	ID permintaan.	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceName	string	Nama layanan titik akhir.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	Status layanan titik akhir. Nilai yang valid: Creating Pending Active Deleting	Active
ServiceDescription	string	Deskripsi layanan titik akhir.	This is my EndpointService.
CreateTime	string	Waktu saat layanan titik akhir dibuat.	2022-01-02T19:11:12Z
ServiceDomain	string	Nama domain layanan titik akhir.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
ZoneAffinityEnabled	boolean	Menunjukkan apakah afinitas zona diaktifkan. Nilai yang valid: true false	false
AutoAcceptEnabled	boolean	Menunjukkan apakah koneksi titik akhir diterima secara otomatis. Nilai yang valid: true: Diterima secara otomatis. false: Tidak diterima secara otomatis.	false
ServiceId	string	ID layanan titik akhir.	epsrv-hp3vpx8yqxblby3i****
ServiceSupportIPv6 `deprecated`	boolean	Menunjukkan apakah IPv6 diaktifkan untuk layanan titik akhir. Nilai yang valid: true false	false
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmy*****
AddressIpVersion	string	Versi IP. Nilai yang valid: IPv4 DualStack	IPv4

Contoh

Respons sukses

JSONformat

{
  "ServiceBusinessStatus": "Normal",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus": "Active",
  "ServiceDescription": "This is my EndpointService.",
  "CreateTime": "2022-01-02T19:11:12Z",
  "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "ZoneAffinityEnabled": false,
  "AutoAcceptEnabled": false,
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****",
  "AddressIpVersion": "IPv4"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	EndpointServiceExist	The specified Endpoint Service already exists.	The specified Endpoint Service already exists.
400	AlbNotFound	The specified Alb does not exist.	The specified Alb does not exist.
400	LoadBalancerNotFound	The specified load balancer does not exist.	The specified Alb does not exist.
400	LoadBalancerNotSupportPrivateLink	The specified SLB does not support PrivateLink.	The specified SLB does not support PrivateLink.
400	GenerateResourceIdFailed	Failed to generate ResourceId.	Failed to generate ResourceId.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.	The resource you applied for has exceeded the quota.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	EndpointServicePayerForbidden	The parameter EndpointServicePayer is forbidden. The user is not in the whitelist.
400	NeedOpenProduct	The product is not activated.	The product is not activated.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.	The specified endpoint service does not support the zone.
400	IllegalParamFormat.%s	The param format of %s is illegal.	The parameter format of %s is illegal.
400	MissingParam.%s	The param of %s is missing.	The parameter %s is missing.
400	ResourceNotFound.NatGateway	The specified resource %s is not found.
400	Mismatch.ResourceType	The %s is mismatched for %s and %s.	The %s is mismatched for %s and %s.
400	EndpointServiceNotSupportIpv6	The param supportIpv6 of EndpointService is forbidden , resource is not support ipv6.	The endpoint service does not support IPv6.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	Conflict.ServiceName	The ServiceName %s is conflict.
400	InvalidParam.PrivateDnsName	The parameter of PrivateDnsName is illegal, which needs to end with aliyun.com, aliyun-inc.com, or aliyuncs.com.
400	OperationDenied.ZoneAffinityNotSupport	The operation is not allowed because of zone affinity not support.	The operation is not allowed because zone affinity is not supported.
400	OperationDenied.RamPolicyNotSupport	The operation is not allowed because of RamPolicyNotSupport.	The operation is not allowed because ram policy are not supported.
400	OperationDenied.ResourceTypeNotSupportDualStack	The specified resource type does not support dualstack.	The specified resource type does not support dualstack.
400	OperationDenied.ServiceResourceIpVersionMismatch	The endpoint service and service resource AddressIpVersion do not match.	The endpoint service and service resource AddressIpVersion do not match.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.	The specified parameter AddressIpVersion does not meet the requirements.
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.	the specified alb instance is not supported.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.