Gunakan API CreateVpcEndpointService untuk membuat layanan endpoint - PrivateLink - Alibaba Cloud - 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 Membuat instans load balancer.
CreateVpcEndpointService adalah operasi asinkron. Setelah permintaan dikirim, sistem akan mengembalikan ID instans, tetapi layanan titik akhir belum dibuat. Node latar belakang masih berjalan. Anda dapat memanggil GetVpcEndpointServiceAttribute untuk mengkueri status pembuatan layanan titik akhir:
- Jika layanan titik akhir berada dalam status Creating, layanan titik akhir sedang dibuat.
- Jika layanan titik akhir berada dalam status Active, layanan 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: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 layanan titik akhir. Anda dapat memanggil operasi 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, sintaks 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): Menjalankan dry run dan menjalankan permintaan aktual. Jika permintaan berhasil dalam dry run, kode status HTTP 2xx akan dikembalikan dan operasi akan dijalankan.	false
ServiceDescription	string	No	Deskripsi layanan titik akhir.	This is my EndpointService.
AutoAcceptEnabled	boolean	No	Apakah akan menerima koneksi titik akhir secara otomatis. Nilai 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 valid: Endpoint: Konsumen layanan. EndpointService: Penyedia layanan.	Endpoint
ZoneAffinityEnabled	boolean	No	Apakah akan mendukung afinitas zona untuk nama domain titik akhir dari layanan titik akhir. Nilai valid: true: Didukung. false (default): Tidak didukung.	false
ServiceResourceType	string	No	Tipe sumber daya EPS. Nilai valid: slb: Classic Load Balancer (CLB). alb: Application Load Balancer (ALB). nlb: Network Load Balancer (NLB). gwlb: Gateway Load Balancer (GWLB). Catatan Akses ke listener TCPSSL NLB tidak didukung.	slb
Resource	array<object>	No	Sumber daya layanan dari layanan titik akhir. Anda dapat menambahkan hingga 10 sumber daya selama pembuatan. Setelah pembuatan, Anda dapat menambahkan lebih banyak sumber daya dengan menambahkan sumber daya layanan ke titik akhir.
	object	No	Sumber daya layanan dari layanan titik akhir.
ResourceType	string	No	Tipe sumber daya EPS yang akan ditambahkan ke layanan titik akhir. Anda dapat menambahkan hingga 20 sumber daya layanan ke layanan titik akhir. Nilai valid: slb: Classic Load Balancer (CLB). alb: Application Load Balancer (ALB). nlb: Network Load Balancer (NLB). gwlb: Gateway Load Balancer (GWLB).	slb
ResourceId	string	No	ID sumber daya layanan yang akan ditambahkan ke layanan titik akhir.	lb-hp32z1wp5peaoox2q****
ZoneId	string	No	ID zona.	cn-huhehaote-a
RegionId	string	Yes	ID wilayah layanan titik akhir. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-huhehaote
ServiceSupportIPv6 `deprecated`	boolean	No	Apakah layanan titik akhir mendukung IPv6. Nilai valid: true: Didukung. false (default): Tidak didukung.	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 instans. Anda dapat menentukan hingga 20 kunci tag. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag dapat mencapai 64 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	env
Value	string	No	Nilai tag instans. Anda dapat menentukan hingga 20 nilai tag. Nilai tag dapat berupa string kosong. Panjang nilai tag dapat mencapai 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Nilai tag tidak boleh mengandung `http://` atau `https://`.	prod
AddressIpVersion	string	No	Versi protokol. Nilai valid: IPv4: IPv4 (default). DualStack: dual-stack. Catatan Hanya layanan titik akhir yang tipe sumber daya backend-nya nlb atau gwlb yang mendukung protokol alamat IP DualStack. Jika layanan titik akhir mendukung dual-stack, sumber daya backend juga harus mendukung dual-stack.	IPv4
SupportedRegionList	array	No	Daftar wilayah yang didukung oleh layanan titik akhir. Konsumen layanan dapat memulai koneksi titik akhir dari wilayah dalam daftar.
	string	No	ID wilayah yang didukung oleh layanan titik akhir.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object
ServiceBusinessStatus	string	Status bisnis layanan titik akhir. Nilai valid: Normal: Normal. FinancialLocked: Kunci finansial.	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 valid: Creating: sedang dibuat. Pending: sedang dimodifikasi. Active: tersedia. Deleting: sedang dihapus.	Active
ServiceDescription	string	Deskripsi layanan titik akhir.	This is my EndpointService.
CreateTime	string	Pengatur waktu ketika 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	Apakah afinitas zona didukung untuk nama domain titik akhir dari layanan titik akhir. Nilai valid: true: Didukung. false: Tidak didukung.	false
AutoAcceptEnabled	boolean	Apakah layanan titik akhir dikonfigurasi untuk menerima koneksi titik akhir secara otomatis. Nilai valid: true: Layanan titik akhir menerima koneksi titik akhir secara otomatis. false: Layanan titik akhir tidak menerima koneksi titik akhir secara otomatis.	false
ServiceId	string	ID layanan titik akhir.	epsrv-hp3vpx8yqxblby3i****
ServiceSupportIPv6 `deprecated`	boolean	Apakah layanan titik akhir mendukung IPv6. Nilai valid: true: Didukung. false: Tidak didukung.	false
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmy*****
AddressIpVersion	string	Versi protokol. Nilai valid: IPv4: IPv4. DualStack: dual-stack.	IPv4
SupportedRegionSet	array<object>	Daftar wilayah yang didukung oleh layanan titik akhir. Konsumen layanan dapat memulai koneksi titik akhir dari wilayah dalam daftar.
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string	Status wilayah yang didukung oleh layanan titik akhir. Nilai valid: Pending: sedang dimodifikasi. Available: tersedia. Deleting: sedang dihapus. Failed: gagal. Closed: ditutup.	Available
RegionBusinessStatus	string	Status bisnis wilayah yang didukung oleh layanan titik akhir. Nilai valid: Normal: Normal. FinancialLocked: Kunci finansial.	Normal
SupportedRegionId	string	ID wilayah yang didukung oleh layanan titik akhir.	cn-hangzhou

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",
  "SupportedRegionSet": [
    {
      "ServiceRegionId": "",
      "RegionServiceStatus": "Available",
      "RegionBusinessStatus": "Normal",
      "SupportedRegionId": "cn-hangzhou"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	EndpointServiceExist	The specified Endpoint Service already exists.
400	AlbNotFound	The specified Alb does not exist.
400	LoadBalancerNotFound	The specified load balancer does not exist.
400	LoadBalancerNotSupportPrivateLink	The specified SLB does not support PrivateLink.
400	GenerateResourceIdFailed	Failed to generate ResourceId.
400	QuotaMisMatched	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.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.
400	IllegalParamFormat.%s	The param format of %s is illegal.
400	MissingParam.%s	The param of %s is missing.
400	ResourceNotFound.NatGateway	The specified resource %s is not found.
400	Mismatch.ResourceType	The %s is mismatched for %s and %s.
400	EndpointServiceNotSupportIpv6	The param supportIpv6 of EndpointService is forbidden , resource is 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.
400	OperationDenied.RamPolicyNotSupport	The operation is not allowed because of RamPolicyNotSupport.
400	OperationDenied.ResourceTypeNotSupportDualStack	The specified resource type does not support dualstack.
400	OperationDenied.ServiceResourceIpVersionMismatch	The endpoint service and service resource AddressIpVersion do not match.
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.