Cloud Deployment Manager akan mencapai akhir dukungan pada 31 Desember 2025. Jika saat ini Anda menggunakan Deployment Manager, migrasikan ke Infrastructure Manager atau teknologi deployment alternatif paling lambat 31 Desember 2025 untuk memastikan layanan Anda berlanjut tanpa gangguan.
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Deployment Manager menawarkan kemampuan untuk mendaftarkan API pihak ketiga dengan layanan Deployment Manager. Setelah mendaftarkan API sebagai
penyedia jenis
dengan Deployment Manager, Anda dapat menggunakan Deployment Manager untuk men-deploy resource dari
API sebagai jenis dalam konfigurasi Anda.
Dokumen ini adalah panduan satu halaman yang menjelaskan proses mengintegrasikan
API pihak ketiga dengan Deployment Manager. Halaman ini tidak berisi petunjuk lengkap untuk setiap langkah proses, tetapi memberikan ringkasan dan link tambahan untuk informasi selengkapnya. Gunakan halaman ini untuk mendapatkan gambaran umum tentang proses penambahan API, tetapi lihat dokumentasi mendetail untuk mengetahui petunjuk langkah demi langkah.
Menentukan apakah API memenuhi syarat untuk diintegrasikan dengan Deployment Manager
Deployment Manager memiliki ekspektasi tertentu terhadap API yang mencoba berintegrasi dengannya. Secara khusus:
Deployment Manager mengharapkan RESTful API. Artinya, API ini mengekspos antarmuka mirip REST dengan metode Create, Read, Update, dan Delete (CRUD).
Semua parameter jalur dan kueri berhasil diselesaikan. Semua parameter jalur dan kueri API harus ada sebagai bagian dari isi resource atau ada di semua metode API, sehingga Deployment Manager dapat mencocokkan parameter saat pengguna menyediakannya.
Endpoint dokumen deskriptor API harus dapat diakses. Deployment Manager membuat permintaan HTTP untuk mendapatkan dokumen deskriptor API sehingga dokumen harus dihosting di suatu tempat yang dapat diakses oleh Deployment Manager. Dokumen
harus tersedia secara publik atau dilindungi dengan autentikasi dasar.
Terkait dengan poin sebelumnya, API memiliki autentikasi dasar, atau,
jika API berjalan di Google Kubernetes Engine atau Google Cloud Endpoints,
API mendukung autentikasi OAuth 2.0 menggunakan token akses dari
akun layanan project. Baca selengkapnya tentang autentikasi.
Jika API Anda kompleks, Anda mungkin perlu mengonfigurasi opsi tambahan untuk
menjelaskan kepada Deployment Manager cara menangani perilaku API yang kurang jelas.
Untuk mengetahui informasi selengkapnya, baca dokumentasi
Persyaratan API.
Menambahkan API ke Deployment Manager
Setelah menentukan bahwa API Anda sesuai dengan persyaratan di atas, tambahkan API sebagai resource Penyedia Jenis. Anda harus memberikan dokumen deskriptor API dan secara opsional, opsi API tambahan menggunakan
opsi lanjutan.
Menambahkan API sebagai penyedia jenis akan mengekspos semua resource API tersebut ke Deployment Manager dan memungkinkan pengguna membuat, memperbarui, atau menghapus resource tersebut dengan Deployment Manager.
Jika API Anda memiliki pola API halus yang mungkin tidak mudah dikenali, Anda juga perlu memberikan pemetaan input ke Deployment Manager agar dapat menangani permintaan API dengan benar. Untuk mengetahui informasi, baca Opsi API Lanjutan.
Memanggil penyedia jenis dalam file konfigurasi
Setelah API didaftarkan dengan Deployment Manager, Anda dapat membuat resource API dengan memanggil resource API tersebut sebagai jenis dalam konfigurasi Anda.
Misalnya, jika Anda memberi nama penyedia jenis example-directory-api dan Anda
ingin membuat resource API yang dikenal sebagai person, Anda dapat menentukan jenis
dalam konfigurasi seperti ini:
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-08-19 UTC."],[[["\u003cp\u003eThis guide provides an overview of integrating third-party APIs with Deployment Manager, enabling users to deploy resources from those APIs as types in their configurations.\u003c/p\u003e\n"],["\u003cp\u003eDeployment Manager requires that integrated APIs be RESTful, have resolvable parameters, and provide an accessible descriptor document, among other requirements.\u003c/p\u003e\n"],["\u003cp\u003eTo integrate an API, users must add it as a Type Provider, supplying a descriptor document and any necessary advanced options to handle complex API behaviors.\u003c/p\u003e\n"],["\u003cp\u003eOnce registered as a Type Provider, an API's resources can be called as types within Deployment Manager configuration files, similar to calling Google API resources.\u003c/p\u003e\n"],["\u003cp\u003eThis feature is currently in Beta, meaning it is subject to the Pre-GA Offerings Terms and has the possibility of having limited support.\u003c/p\u003e\n"]]],[],null,["# Integrating with Deployment Manager\n\n| **Beta**\n|\n|\n| This product or feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products and features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nDeployment Manager offers the ability to register a third-party API with the\nDeployment Manager service. After registering an API as a\n[type provider](/deployment-manager/docs/configuration/type-providers/creating-type-provider)\nwith Deployment Manager, you can use Deployment Manager to deploy resources from\nthe API as types in your configuration.\n\nThis document is a one-page guide that describes the process of integrating a\nthird-party API with Deployment Manager. This page does not contain\ncomprehensive instructions for each step of the process but provides an\noverview and additional links for more information. Use this page to\ngain a high-level view of the process for adding an API but refer to the\ndetailed documentation for step-by-step instructions.\n\nDetermining if an API is eligible for integrating with Deployment Manager\n-------------------------------------------------------------------------\n\nDeployment Manager has certain expectations of any API that attempts to\nintegrate with it. Specifically:\n\n- Deployment Manager expects a RESTful API. That is, the API exposes a REST-like interface with Create, Read, Update, and Delete (CRUD) methods.\n- All path and query parameters resolve successfully. All path and query parameters of the API must exist as part of the resource body or exist on all methods of the API, so that Deployment Manager can match the parameter when a user supplies it.\n- The API's descriptor document endpoint must be accessible. Deployment Manager makes an HTTP request to get an API's descriptor document so the document must be hosted somewhere accessible by Deployment Manager. The document must be publicly available or protected by basic authentication.\n- Related to the previous point, the API has either basic authentication, or, if the API is running on Google Kubernetes Engine or Google Cloud Endpoints, the API supports OAuth 2.0 authentication using an access token from the project's service account. Read more about [authentication](/deployment-manager/docs/configuration/type-providers/creating-type-provider#authentication).\n- If your API is complex, you might need to configure additional options to explain to Deployment Manager how to handle less obvious API behavior.\n\nFor more information, read the\n[API Requirements](/deployment-manager/docs/configuration/type-providers/api-requirements)\ndocumentation.\n\nAdding your API to Deployment Manager\n-------------------------------------\n\nAfter determining that your API matches the requirements above,\n[add the API as a Type Provider](/deployment-manager/docs/configuration/type-providers/creating-type-provider)\nresource. You must provide an API descriptor document and optionally, any\nadditional API options using\n[advanced options](/deployment-manager/docs/configuration/type-providers/advanced-configuration-options).\nAdding an API as a type provider exposes all resources of that API to Deployment\nManager and allows users to create, update, or delete those resources with\nDeployment Manager.\n\nIf your API has subtle API patterns that might not be easily recognizable, you\nwill need to also provide input mappings to Deployment Manager so it can\nproperly handle API requests. For information, read\n[Advanced API Options](/deployment-manager/docs/configuration/type-providers/advanced-configuration-options).\n\nCalling a type provider in configuration files\n----------------------------------------------\n\nOnce an API is registered with Deployment Manager, you can create API resources\nby calling that API resource as a type in your configuration.\n\nFor example, if you named your type provider `example-directory-api` and you\nwant to create an API resource known as `person`, you can specify the type\nin your configurations like so: \n\n resources:\n - name: Jane\n type: my-project/example-directory-api:person\n properties:\n - name: Jane\n website: www.example.com\n ...\n\nTo compare, this is the same process as calling a Google API and\ncreating an API resource: \n\n resource:\n - name: example-instance\n type: compute.v1.instance\n properties:\n - machineType: n1-standard-1\n ...\n\nWhat's next\n-----------\n\n- Read about the [API requirements](/deployment-manager/docs/configuration/type-providers/api-requirements) for adding an API to Deployment Manager\n- Follow the instructions to [add an API](/deployment-manager/docs/configuration/type-providers/creating-type-provider).\n- Learn more about [advanced API options](/deployment-manager/docs/configuration/type-providers/advanced-configuration-options).\n- Learn more about [types](/deployment-manager/docs/fundamentals#types).\n- Read about [creating a configuration](/deployment-manager/docs/configuration).\n- [Create a deployment](/deployment-manager/docs/deployments)."]]
