Metadata API—seperti gaya API, protokol yang didukung, dan definisi parameter—diperlukan untuk menandatangani permintaan API Alibaba Cloud secara mandiri. Pelajari cara membaca dan mengambil metadata ini.
Ikhtisar metadata produk cloud
Metadata OpenAPI adalah kumpulan informasi deskriptif untuk API suatu produk cloud. Saat proses penandatanganan, ekstrak gaya API, protokol yang didukung, metode permintaan, nama parameter, tipe, dan lokasinya dari metadata ini.
Ikhtisar produk dan versi (Info)
Mencakup gaya API, kode produk, dan versi.
Contoh:
{"style":"RPC","product":"Ecs","version":"2014-05-26"}
Kumpulan ringkasan API (apis)
Map yang diindeks berdasarkan nama API, dengan setiap nilai berupa ringkasan API yang mencakup parameter berikut:
|
Nama parameter |
Deskripsi |
Contoh |
|
methods |
Metode permintaan yang didukung. |
Baik POST maupun GET menghasilkan respons yang identik. |
|
schemes |
Protokol yang didukung. |
HTTP dan HTTPS keduanya didukung. |
|
parameters |
Parameter permintaan. |
Menjelaskan nama, lokasi (query, path, atau body), tipe, dan status wajib setiap parameter. |
Kumpulan titik akhir (endpoints)
Titik akhir layanan untuk produk cloud.
Cara memperoleh metadata
Metode 1: Dapatkan metadata produk cloud
Pada halaman atau dokumentasi API, pilih produk cloud seperti Elastic Compute Service (ECS), lalu klik Get Metadata di bawah nama produk.
Metode 2: Dapatkan metadata untuk API tertentu
Pada halaman atau dokumentasi API, pilih produk cloud seperti ECS, pilih API target, lalu klik Get Metadata di pojok kanan atas.
Metode 3: Panggil API metadata
API metadata dapat diakses publik tanpa otentikasi. Gunakan titik akhir berikut untuk mengambil metadata. Referensi API lengkap tersedia di atau Panduan penggunaan metadata.
|
Deskripsi API |
URL API |
Metode permintaan |
|
Daftar semua kode dan versi produk cloud |
https://api.aliyun.com/meta/v1/products.json?language=EN_US |
GET |
|
Dapatkan metadata untuk produk dan versi tertentu |
https://api.aliyun.com/meta/v1/products/{product}/versions/{version}/api-docs.json |
GET |
|
Dapatkan metadata untuk API tertentu |
https://api.aliyun.com/meta/v1/products/{product}/versions/{version}/apis/{api_name}/api.json |
GET |