Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
AWS Service Catalog Ikhtisar API
Manfaat Menggunakan Service Catalog API
AWS Service Catalog API menyediakan kontrol terprogram atas semua tindakan pengguna akhir sebagai alternatif untuk menggunakan. Konsol Manajemen AWS Saat Anda menggunakan API, Anda dapat melakukan hal berikut:
-
Tulis antarmuka dan aplikasi khusus Anda sendiri
-
Dapatkan kontrol halus dari operasi penyediaan produk pengguna akhir
-
Integrasikan penyediaan sumber daya ke dalam jalur orkestrasi Anda
-
Akses lokasi pusat yang meng-host aplikasi Anda dengan sumber dayanya
Access Service Catalog
Untuk membangun aplikasi menggunakan API khusus bahasa, gunakan pustaka, kode sampel, tutorial, dan sumber daya lainnya untuk pengembang perangkat lunak. Pustaka ini menyediakan fungsi dasar yang mengotomatiskan tugas-tugas seperti menandatangani permintaan Anda secara kriptografis, mencoba kembali permintaan, dan menangani respons kesalahan, sehingga memudahkan Anda untuk memulai. Untuk memulai, buka Alat untuk Amazon Web Services
Jika Anda memilih menggunakan antarmuka baris perintah, Anda memiliki opsi berikut:
- AWS Antarmuka Baris Perintah (CLI)
-
Untuk memulai, lihat Panduan Pengguna AWS Command Line Interface. Untuk informasi selengkapnya tentang perintah untuk Service Catalog, lihat servicecatalog di Command Reference.AWS CLI
- AWS Alat untuk Windows PowerShell
-
Untuk memulai, lihat Panduan Pengguna Alat AWS untuk PowerShell. Untuk informasi selengkapnya tentang cmdlet untuk Service Catalog, buka Referensi Alat AWS untuk PowerShell Cmdlet dan perluas. AWS Service Catalog
AWS Service Catalog API dapat dibagi secara logis ke dalam kategori berikut.
Topik
Penemuan Produk
Gunakan operasi ini untuk menemukan atau mendapatkan informasi tentang produk dan persyaratan peluncuran untuk mereka. Operasi ini tidak membuat atau memodifikasi sumber daya.
- SearchProducts
-
Daftar semua produk yang dapat diakses oleh penelepon.
- DescribeProduct
-
Dapatkan informasi rinci tentang suatu produk.
- DescribeProductView
-
Fungsional identik dengan
DescribeProduct, kecuali bahwa dibutuhkan ID tampilan produk bukan ID produk. - ListLaunchPaths
-
Daftar semua cara pengguna memiliki akses ke produk tertentu, disebut sebagai jalur ke produk. Seorang pengguna harus memilih jalur untuk menyediakan produk.
- DescribeProvisioningParameters
-
Mendapatkan parameter yang diperlukan untuk menyediakan produk tertentu, dan menyediakan metadata tambahan tentang apa yang akan terjadi ketika produk disediakan.
Masing-masing
ProvisioningArtifactParameteradalah sesuatu yang harus ditentukan pengguna agar berhasil menyediakan produk (misalnya, ukuran instance EC2).ConstraintSummaryObjek berisi daftar nilai yang diijinkan dan metadata tambahan tentang objek.ProvisioningArtifactParameter
Permintaan Penyediaan
Gunakan operasi ini untuk meminta, memperbarui, atau menghentikan penyediaan produk.
- ProvisionProduct
-
Meminta penyediaan produk. Menyediakan produk berarti meluncurkan sumber daya yang dibutuhkan untuk membawa produk tersebut secara online untuk penggunaan aktual. Misalnya, penyediaan produk yang didukung oleh CloudFormation template berarti meluncurkan CloudFormation tumpukan dan semua sumber daya dasarnya.
- UpdateProvisionedProduct
-
Memperbarui konfigurasi produk yang disediakan. Misalnya, produk yang didukung oleh CloudFormation pembaruan CloudFormation tumpukan dasarnya. Pemohon harus memiliki izin akses yang cukup ke yang ditentukan. ProvisionedProduct
- TerminateProvisionedProduct
-
Meminta penghentian produk yang disediakan. Misalnya, untuk produk yang didukung oleh CloudFormation, ini menghapus CloudFormation tumpukan yang mendasarinya. Pemohon harus memiliki izin akses yang memadai ke produk yang disediakan yang ditentukan.
Produk yang Disediakan
Gunakan operasi ini untuk mendapatkan informasi tentang produk yang disediakan. Operasi ini tidak membuat atau memodifikasi sumber daya.
- ListRecordHistory
-
Mencantumkan semua permintaan yang dilakukan, bahkan untuk produk yang disediakan dihentikan.
- DescribeRecord
-
Mendapat informasi tentang permintaan. Gunakan operasi ini setelah operasi permintaan untuk mendapatkan
RecordDetailinformasi terkini. - SearchProvisionedProducts
-
Mendapat informasi tentang produk yang disediakan yang memenuhi kriteria yang ditentukan.
- ScanProvisionedProducts
-
Daftar produk yang disediakan yang tidak dihentikan.
- DescribeProvisionedProduct
-
Mendapat informasi tentang produk yang disediakan.
- ImportAsProvisionedProduct
-
Meminta impor sumber daya sebagai produk yang disediakan Service Catalog yang terkait dengan produk Service Catalog dan artefak penyediaan. Setelah diimpor, semua tindakan tata kelola Service Catalog yang didukung didukung pada produk yang disediakan.
- UpdateProvisionedProductProperties
-
Meminta pembaruan ke properti produk yang disediakan yang ditentukan.
Paket Produk yang Disediakan
Gunakan operasi ini untuk mengelola paket produk yang disediakan. Sebuah rencana mencakup daftar sumber daya untuk membuat atau memodifikasi ketika Anda menjalankan rencana.
- CreateProvisionedProductPlan
Membuat rencana.
- DescribeProvisionedProductPlan
Mendapat informasi tentang perubahan sumber daya untuk sebuah rencana.
- ExecuteProvisionedProductPlan
Menyediakan atau memodifikasi produk berdasarkan rencana.
- ListProvisionedProductPlans
Daftar rencana untuk produk yang disediakan.
- DeleteProvisionedProductPlan
Menghapus rencana.
Portofolio
Administrator katalog menggunakan operasi ini menyediakan semua operasi yang diperlukan untuk manajemen portofolio.
- CreatePortfolio
Membuat portofolio.
- DeletePortfolio
Menghapus portofolio.
- DescribePortfolio
Mendapat informasi rinci tentang portofolio.
- DescribePortfolioShares
Mengembalikan ringkasan dari masing-masing saham portofolio yang dibuat untuk portofolio yang ditentukan.
- ListPortfolios
Daftar semua portofolio dalam katalog.
- ListPortfoliosForProduct
Daftar semua portofolio yang terkait dengan produk.
- UpdatePortfolio
Memperbarui portofolio.
- UpdatePortfolioShare
Memperbarui bagian portofolio.
- CreatePortfolioShare
Berbagi portofolio dengan AWS akun.
- DeletePortfolioShare
Berhenti berbagi portofolio.
- AcceptPortfolioShare
Menerima tawaran untuk berbagi portofolio.
- RejectPortfolioShare
Menolak tawaran untuk berbagi portofolio.
- ListAcceptedPortfolioShares
Daftar rincian semua portofolio yang berbagi diterima oleh akun ini.
- ListPortfolioAccess
Daftar ID akun yang memiliki akses ke portofolio.
Asosiasi Kepala Sekolah
Administrator katalog menggunakan operasi ini menyediakan semua operasi yang diperlukan untuk asosiasi utama.
- AssociatePrincipalWithPortfolio
Mengaitkan ARN utama dengan portofolio.
- DisassociatePrincipalFromPortfolio
Memutus ARN utama dari portofolio.
- ListPrincipalsForPortfolio
Daftar semua ARN utama yang terkait dengan portofolio.
Produk
Administrator katalog menggunakan operasi ini menyediakan semua operasi yang diperlukan untuk manajemen produk.
- SearchProductsAsAdmin
Mendapat ringkasan dan informasi status untuk produk.
- DescribeProductAsAdmin
Mendapat informasi tentang suatu produk.
- CreateProduct
Menciptakan produk.
- CopyProduct
Menyalin produk.
- DescribeCopyProductStatus
Mendapat status operasi produk salinan.
- UpdateProduct
Memperbarui produk.
- DeleteProduct
Menghapus produk.
- AssociateProductWithPortfolio
Mengaitkan produk dengan portofolio.
- DisassociateProductFromPortfolio
Memisahkan produk dari portofolio.
Penyediaan Artefak
Administrator katalog menggunakan operasi ini untuk mengelola artefak penyediaan (juga dikenal sebagai versi produk).
- DescribeProvisioningArtifact
Mendapat informasi tentang artefak penyediaan.
- CreateProvisioningArtifact
Membuat artefak penyediaan untuk suatu produk.
- DeleteProvisioningArtifact
Menghapus artefak penyediaan.
- ListProvisioningArtifacts
Daftar semua artefak penyediaan yang terkait dengan suatu produk.
- UpdateProvisioningArtifact
Memperbarui artefak penyediaan.
Batasan
Administrator katalog menggunakan operasi ini mengelola kendala.
- CreateConstraint
Menciptakan kendala.
- DeleteConstraint
Menghapus kendala.
- DescribeConstraint
Mendapat informasi tentang kendala.
- UpdateConstraint
Memperbarui kendala.
- ListConstraintsForPortfolio
Mendapat informasi kendala untuk portofolio dan produk.
Tindakan Layanan
Administrator katalog menggunakan operasi ini untuk mengelola tindakan layanan.
- AssociateServiceActionWithProvisioningArtifact
Mengaitkan tindakan swalayan dengan artefak penyediaan.
- CreateServiceAction
Menciptakan tindakan layanan mandiri.
- DeleteServiceAction
Menghapus tindakan swalayan.
- DescribeServiceAction
Menjelaskan tindakan swalayan.
- DescribeServiceActionExecutionParameters
Menemukan parameter default untuk tindakan swalayan tertentu pada produk tertentu yang disediakan dan mengembalikan peta hasil kepada pengguna.
- ExecuteProvisionedProductServiceAction
Mengeksekusi tindakan swalayan terhadap produk yang disediakan.
- UpdateServiceAction
Memperbarui tindakan swalayan.
TagOptions
Administrator katalog menggunakan operasi ini untuk mengelola TagOptions.
- CreateTagOption
Menciptakan a TagOption.
- ListTagOptions
Daftar Anda TagOptions.
- DescribeTagOption
Menjelaskan a TagOption.
- UpdateTagOption
Pembaruan a TagOption.
- AssociateTagOptionWithResource
Mengaitkan a TagOption dengan sumber daya.
- DisassociateTagOptionFromResource
Memisahkan a TagOption dari sumber daya.
- ListResourcesForTagOption
Daftar sumber daya untuk a TagOption.
- DeleteTagOption
Menghapus a. TagOption
AppRegistry
Berfungsi sebagai repositori untuk aplikasi Anda, sumber dayanya, dan metadata aplikasi yang Anda gunakan di perusahaan Anda.
- AssociateAttributeGroup
Mengaitkan grup atribut dengan aplikasi untuk menambah metadata aplikasi dengan atribut grup.
- AssociateResource
Mengaitkan sumber daya dengan aplikasi.
- CreateApplication
Membuat aplikasi baru yang merupakan node tingkat atas dalam hierarki abstraksi sumber daya cloud terkait.
- CreateAttributeGroup
Membuat grup atribut baru sebagai kontainer untuk atribut yang ditetapkan pengguna.
- DeleteApplication
Menghapus aplikasi yang ditentukan baik oleh ID aplikasi atau nama.
- DeleteAttributeGroup
Menghapus grup atribut, ditentukan baik oleh ID grup atribut atau nama.
- DisassociateAttributeGroup
Memutuskan grup atribut dari aplikasi untuk menghapus atribut tambahan yang terdapat dalam grup atribut dari metadata aplikasi.
- DisassociateResource
Memisahkan sumber daya dari aplikasi.
- GetApplication
Mengambil informasi metadata tentang salah satu aplikasi Anda.
- GetAssociatedResource
Mendapat sumber daya yang terkait dengan aplikasi.
- GetAttributeGroup
Mengambil grup atribut, baik dengan namanya atau ID-nya.
- ListApplications
Daftar semua grup atribut yang terkait dengan aplikasi tertentu.
- ListAssociatedAttributeGroups
Daftar semua grup atribut yang terkait dengan aplikasi tertentu.
- ListAssociatedResources
Daftar semua sumber daya yang terkait dengan aplikasi tertentu.
- ListAttributeGroups
Daftar semua grup atribut yang dapat Anda akses.
- ListAttributeGroupsForApplication
Daftar rincian semua grup atribut yang terkait dengan aplikasi tertentu.
- ListTagsForResource
Daftar semua tag pada sumber daya.
- TagResource
Menetapkan satu atau lebih tag (pasangan kunci-nilai) ke sumber daya yang ditentukan.
- SyncResource
Menyinkronkan sumber daya dengan apa yang saat ini direkam. AppRegistry
- UntagResource
Menghapus tag dari sebuah sumber daya.
- UpdateApplication
Memperbarui aplikasi yang ada dengan atribut baru.
- UpdateAttributeGroup
Memperbarui grup atribut yang ada dengan detail baru.
Contoh Alur Kerja
Dalam skenario ini, administrator membuat sumber daya menggunakan AWS Service Catalog dan pengguna akhir menemukan produk apa yang tersedia dan menyediakan produk. Ini adalah contoh alur kerja; ini bukan satu-satunya cara untuk menggunakan AWS Service Catalog API.
Tugas Administrator
Buat portofolio, tampilan produk, produk, versi produk, dan kendala.
Tetapkan pengguna IAM ke produk, yang memberi mereka akses.
Tugas Pengguna Akhir
-
Pengguna memanggil SearchProductstanpa argumen. Ini mengembalikan daftar produk yang dapat diakses pengguna, serta "SearchDomain" yang dapat digunakan untuk cakupan hasil.
-
Pengguna terus menelepon SearchProductsdengan filter pencarian tambahan sampai produk yang diinginkan ditemukan.
-
Pengguna memanggil DescribeProductViewuntuk menemukan daftar artefak penyediaan (juga dikenal sebagai versi) untuk produk ini. Ini menentukan apa yang sebenarnya disediakan pengguna.
-
Pengguna memanggil ListLaunchPathsuntuk menemukan daftar jalur untuk produk ini, bersama dengan batasan untuk setiap jalur. Ini menentukan set kendala apa yang diterapkan pada produk yang disediakan.
-
Setelah memilih artefak penyediaan dan jalur, pengguna memanggil. DescribeProvisioningParameters Ini mengembalikan daftar parameter yang harus disediakan pengguna sebelum menyediakan produk menggunakan artefak dan jalur penyediaan, bersama dengan instruksi penggunaan tambahan apa pun yang diputuskan administrator untuk diberikan.
-
Pengguna memanggil ProvisionProduct, menentukan produk, menyediakan artefak, jalur, dan parameter input. Parameter input adalah daftar pasangan kunci-nilai, di mana kunci diperoleh dengan menggunakan DescribeProvisioningParametersdan nilainya disediakan pengguna (misalnya,).
{ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"}Ini memulai alur kerja untuk membuat AWS sumber daya yang ditentukan. Ini juga membuat detail rekaman yang melacak permintaan penyediaan, dan objek produk yang disediakan yang mewakili sumber daya yang mendasarinya. AWS -
Pengguna melakukan polling DescribeRecorduntuk melihat kapan status detail rekaman berubah dari status ke
IN_PROGRESSstatus selesai (baikSUCCEEDEDatauERROR). -
Ketika detail catatan untuk permintaan dalam keadaan selesai, pengguna memanggil DescribeRecordsekali lagi. Output mengidentifikasi sumber daya yang dibuat.
-
Pengguna memanggil UpdateProvisionedProductuntuk memperbarui sumber daya yang mendasarinya. Bergantung pada pembaruan spesifik yang diminta, operasi ini dapat diperbarui tanpa gangguan, dengan beberapa gangguan, atau mengganti produk yang disediakan sepenuhnya.
-
Akhirnya, pengguna memanggil TerminateProvisionedProductuntuk menghentikan produk yang disediakan.
