Alibaba Cloud SDK:FAQ tentang SDK untuk Python

Bagaimana cara menangani error AccessKey?

Masalah: Pesan error berikut dikembalikan setelah menjalankan kode, yang menunjukkan bahwa pasangan AccessKey tidak dikonfigurasi dengan benar.

• Alibaba Cloud SDK V2.0: AttributeError: 'NoneType' object has no attribute 'get_access_key_id'.

• Alibaba Cloud SDK V1.0: Error:MissingParameter The input parameter "AccessKeyId" that is mandatory for processing this request is not supplied.

Solusi:

1. Jalankan perintah berikut untuk memeriksa apakah variabel lingkungan ALIBABA_CLOUD_ACCESS_KEY_ID dan ALIBABA_CLOUD_ACCESS_KEY_SECRET telah dikonfigurasi.

   Linux/macOS

   echo $ALIBABA_CLOUD_ACCESS_KEY_ID
   echo $ALIBABA_CLOUD_ACCESS_KEY_SECRET

   Windows

   echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
   echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%

   Jika pasangan AccessKey yang valid dikembalikan, berarti variabel lingkungan telah dikonfigurasi dengan benar. Jika tidak ada pasangan AccessKey atau pasangan AccessKey tidak valid yang dikembalikan, konfigurasikan variabel lingkungan sesuai kebutuhan. Untuk informasi selengkapnya, lihat Konfigurasi variabel lingkungan di Linux, macOS, dan Windows.

2. Periksa kesalahan terkait pasangan AccessKey dalam kode.

   Contoh permintaan error:

    config = open_api_models.Config(
               access_key_id=os.environ['yourAccessKeyID'],
               access_key_secret=os.environ['yourAccessKeySecret']
           )

   Contoh permintaan sukses:

    config = open_api_models.Config(
              access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
              access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
           )

   Catatan

   os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'] dan os.environ["ALIBABA_CLOUD_ACCESS_KEY_SECRET"] menentukan bahwa ID AccessKey dan rahasia AccessKey diperoleh dari variabel lingkungan ALIBABA_CLOUD_ACCESS_KEY_ID dan ALIBABA_CLOUD_ACCESS_KEY_SECRET.

   Penting

   Untuk mencegah risiko keamanan, jangan menuliskan pasangan AccessKey dalam kode yang digunakan di lingkungan produksi.

Apa yang harus saya lakukan jika SDK gagal diinstal?

• Pastikan versi Python yang valid telah diinstal, seperti Python 3.x.

• Tambahkan opsi --upgrade saat menginstal SDK dengan menjalankan perintah pip. Hal ini memastikan bahwa versi terbaru diinstal.

pip install --upgrade <SDK_NAME>  

• Jika Anda mengalami masalah izin selama proses instalasi, misalnya saat menginstal SDK di direktori sistem pustaka Python, Anda dapat menggunakan opsi --user untuk menginstal SDK di direktori pengguna alih-alih direktori sistem.

pip install --user <SDK_NAME>  

• Jika beberapa versi Python diinstal di PC Anda, pastikan Anda menginstal SDK pada versi Python yang Anda gunakan. Misalnya, gunakan python3 alih-alih python dalam kode dan jalankan perintah pip3.

Apa yang harus saya lakukan jika modul gagal diimpor dan muncul error ModuleNotFoundError?

Pastikan SDK telah diinstal dengan benar. Kemudian, coba impor modul dalam lingkungan Python.

• Jalankan interpreter Python.

python

• Impor modul.

import <SDK_NAME> 

Jika tidak terjadi error, berarti SDK telah diinstal dengan benar. Jika muncul error ModuleNotFoundError atau ImportError, berarti SDK belum diinstal dengan benar.

pip install <SDK_NAME>

Apa yang harus saya lakukan jika pesan error "AttributeError: 'CredentialModel' object has no attribute 'provider_name'" dikembalikan?

Apa yang harus saya lakukan jika pesan error berikut dikembalikan: code: 400, The input parameter "AccesskeyId" that is mandatory for processing this request is not supplied?

• Pesan error ini muncul karena permintaan yang dikirim ke gerbang tidak berisi ID AccessKey.

• Periksa apakah ID AccessKey Anda telah dikonfigurasi dengan benar saat menggunakan kode contoh lengkap yang diunduh dari OpenAPI Explorer. Konfigurasikan ID AccessKey dan rahasia AccessKey Anda saat memanggil metode utama.

Pada tab SDK Sample di OpenAPI Explorer, temukan accessKeyId dan accessKeySecret dalam metode main dan ganti nilai placeholder dengan AccessKey Anda.

Apa yang harus saya lakukan jika pesan error berikut dikembalikan: Tea.exceptions.TeaException: Error: SignatureDoesNotMatch.MissingHeader code: 400, The specified signed header "accept;connection;content-type;host;user-agent;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version" is not found?

Pesan error ini muncul karena header Connection diatur ke close untuk menerapkan koneksi singkat saat memanggil layanan dalam mode tanda tangan sendiri. Namun, metode signature V3 tidak kompatibel dengan pengaturan ini, sehingga menyebabkan error.

Anda dapat memperbaiki error ini dengan pengaturan berikut: config.signature_algorithm = 'v2'.

Apa yang harus saya lakukan jika pesan error berikut dikembalikan: Tea.exceptions.TeaException: Connection aborted?

Pesan error ini muncul karena interval permintaan lebih lama dari yang diharapkan. Server hanya mempertahankan koneksi persisten selama 30 detik, sedangkan client mempertahankan koneksi secara persisten. Dalam kasus ini, server menutup koneksi setelah 30 detik. Jika client menginisiasi permintaan setelah 30 detik, permintaan akan gagal.

• Atur header Connection ke close untuk menerapkan koneksi singkat.

• Konfigurasikan mekanisme retry untuk memastikan pemanggilan dilakukan dalam waktu 30 detik.

Apa yang harus saya lakukan jika pemanggilan API mengalami timeout dan muncul pesan error "requests.exceptions.Timeout" atau "requests.exceptions.ConnectionError"?

Timeout pemanggilan API dapat disebabkan oleh berbagai faktor. Bagian berikut menjelaskan penyebab umum dan solusi yang sesuai.

Masalah koneksi jaringan

Penyebab: Permintaan tidak dapat mencapai server karena koneksi jaringan antara client dan server gagal atau jaringan tidak stabil.

Solusi:

Jalankan perintah ping atau curl untuk menguji konektivitas antara host lokal dan titik akhir layanan cloud. Misalnya, jalankan perintah ping dysmsapi.aliyuncs.com atau curl -v https://dysmsapi.aliyuncs.com untuk menguji konektivitas antara host lokal Anda dan titik akhir API Short Message Service (SMS).

• Jika perintah mengalami timeout atau tidak menerima respons, periksa kebijakan pemblokiran pada firewall atau router lokal Anda.

• Jika respons dikembalikan, kami menyarankan Anda menentukan periode timeout yang tepat untuk mencegah kegagalan permintaan akibat konfigurasi timeout yang tidak sesuai. Untuk informasi selengkapnya, lihat Konfigurasi periode timeout. Contoh kode:

• # Periode timeout hanya berlaku untuk permintaan yang menggunakan RuntimeOptions.
  runtimeOptions = RuntimeOptions(
      connect_timeout=5000  # Konfigurasi periode timeout untuk permintaan koneksi. Satuan: milidetik.
  )

Penyebab 2: Waktu pemrosesan permintaan yang lama

Penyebab: Waktu pemrosesan permintaan API melebihi periode read timeout yang ditentukan.

Solusi: Perpanjang periode timeout untuk respons API. Untuk informasi selengkapnya, lihat Konfigurasi periode timeout. Misalnya, Anda dapat mengonfigurasi parameter read timeout untuk memperpanjang periode read timeout. Contoh kode:

# Periode timeout hanya berlaku untuk permintaan yang menggunakan RuntimeOptions.
runtimeOptions = RuntimeOptions(
    read_timeout=10000,  # Konfigurasi periode timeout untuk permintaan baca. Satuan: milidetik.
)

Apa yang harus saya lakukan jika pesan error "-bash: python3: command not found" muncul di Linux?

Jika Anda telah menginstal Python, pesan error ini mungkin muncul karena tautan simbolik tidak dikonfigurasi dengan benar.

• Jalankan perintah which python3 pip3 untuk memeriksa apakah tautan simbolik ada di sistem. Jika tautan simbolik ada, hapus tautan simbolik tersebut.

rm -rf /usr/bin/python3 /usr/bin/pip3

• Buat kembali tautan simbolik. Temukan direktori instalasi Python, akses direktori bin, lalu cari pip3.12 dan python3.12. Jalankan perintah berikut untuk membuat tautan simbolik:

sudo ln -s /usr/local/python3/bin/python3.12 /usr/bin/python3
sudo ln -s /usr/local/python3/bin/pip3.12 /usr/bin/pip3

Apa yang harus saya lakukan jika muncul error "Invalid parameters" atau "MissingRequiredParameter" saat memanggil operasi API?

Dalam contoh ini, digunakan operasi SendSms dari Short Message Service (SMS).

• Buka halaman API Debugging di OpenAPI Explorer, lalu pilih produk cloud dan API.

• Periksa apakah semua parameter yang diperlukan seperti PhoneNumbers dan SignName telah ditentukan dalam objek permintaan yang dibuat. Dalam contoh ini, digunakan objek SendSmsRequest.

• Verifikasi bahwa semua parameter yang diperlukan telah ditentukan berdasarkan referensi API.

• Pastikan nilai parameter yang diperlukan valid. Misalnya, periksa apakah nomor ponsel ditentukan dalam format yang valid.

• Sebelum SDK mengirim permintaan API, SDK secara otomatis memverifikasi parameter. Jika satu atau beberapa parameter yang diperlukan tidak ditentukan, error seperti MissingRequiredParameter akan dilaporkan. Misalnya, jika parameter PhoneNumbers tidak ditentukan, error "MissingPhoneNumbers: code: 400" akan dilaporkan. Dalam kasus ini, tentukan parameter berdasarkan pesan error.

Memanggil API tanpa parameter nomor telepon menghasilkan error MissingPhoneNumbers: code: 400 di Konsol.

send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
            # Nomor ponsel tujuan pengiriman pesan teks.
            phone_numbers='<YOUR_VALUE>',
            # Nama signature SMS.
            sign_name='<YOUR_VALUE>',
            # Kode template SMS.
            template_code='<YOUR_VALUE>',
            # Variabel template SMS. Tentukan nilai dalam format JSON. Contoh: {"code":"1234","name":"1234","time":"1234"}.
            template_param='{"code":"1234","name":"1234","time":"1234"}'
        )

Apa yang harus saya lakukan jika operasi API gagal dipanggil dan muncul error "Tea.exceptions.UnretryableException"?

Pastikan wilayah yang Anda pilih mendukung layanan yang Anda panggil. Sebagai contoh, untuk SMS, Anda dapat menemukan titik akhir layanan di halaman produknya di OpenAPI Explorer. Gunakan titik akhir yang benar untuk wilayah Anda.

Klik tab Service Area List di halaman utama produk. Gunakan kolom Region ID dan Service Address untuk menemukan titik akhir yang benar untuk setiap wilayah. Misalnya, titik akhir untuk SMS di wilayah Tiongkok Daratan adalah dysmsapi.aliyuncs.com.

Apa yang harus saya lakukan jika pesan error berikut dikembalikan: File "/usr/local/python3/lib/python3.6/site-packages/alibabacloud_slb20140515/client.py", line 4, in <module> from Tea.core import TeaCore ModuleNotFoundError: No module named 'Tea'?

Pesan error ini muncul karena versi pip sudah usang. Dalam kasus ini, dependensi yang diinstal tidak lengkap atau dependensi tertentu dihapus. Anda dapat memperbarui pip dan menjalankan perintah pip install <Installation package> untuk memperbaiki error ini. Misalnya, jalankan perintah pip install alibabacloud-tea untuk menginstal modul Tea.

Pertanyaan 13: Apa yang harus saya lakukan jika pesan error berikut dikembalikan: Command "python setup.py egg_info" failed with error code 1 in xxx?

Pesan error ini muncul karena versi Python atau pip sudah usang, atau pustaka atau paket yang diperlukan belum diinstal. Akibatnya, SDK tidak dapat berfungsi sebagaimana mestinya.

Solusi:

1. Periksa versi SSL/TLS: Pastikan lingkungan Python pada perangkat lokal mendukung versi SSL/TLS yang digunakan server untuk berkomunikasi. Dalam beberapa kasus, server hanya mendukung TLS 1.2.

   import ssl
   import urllib3
   # Buat konteks SSL yang menggunakan TLS 1.2.
   ssl_context = ssl.create_urllib3_context(ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv3, ssl.OP_NO_TLSv1, ssl.OP_NO_TLSv1_1)
   # Inisialisasi pengelola pool urllib3.
   http = urllib3.PoolManager(context=ssl_context)
   # Kirim permintaan.
   response = http.request('GET', 'https://ocr-api.cn-hangzhou.aliyuncs.com/?Country=Vietnam')
             

2. Periksa masalah lingkungan Python:

   1. Pastikan modul ssl dan versi pustaka urllib3 kompatibel dengan versi Python.

   2. Gunakan lingkungan virtual untuk menginstal ulang Python dan dependensinya.

   python -m venv myenv
   source myenv/bin/activate
   pip install requests urllib3 pyOpenSSL

3. Periksa kesalahan konfigurasi jaringan.

   1. Pastikan firewall pada perangkat lokal mengizinkan traffic ke port HTTPS (port 443).

   2. Jika Anda menggunakan server proxy, pastikan konfigurasinya benar.

   import requests
   # Gunakan proxy
   proxies = {
       'http': 'http://your-proxy-server:port',
       'https': 'https://your-proxy-server:port'
   }
   response = requests.get(
       'https://ocr-api.cn-hangzhou.aliyuncs.com/?Country=Vietnam',
       proxies=proxies
   )

4. Perbarui pustaka requests dan urllib3 untuk menyelesaikan masalah ini.

   pip install --upgrade requests urllib3

5. Jika masalah tetap terjadi setelah pembaruan, kemungkinan besar disebabkan oleh sertifikat lingkungan. Konfigurasikan parameter berikut untuk mengabaikan sertifikat dan sesuaikan periode timeout:

   # Abaikan verifikasi sertifikat.
   runtimeOptions = RuntimeOptions(
    ignore_ssl=True # Mengabaikan verifikasi sertifikat SSL. Verifikasi diaktifkan secara default.
   )
   # Sesuaikan timeout.
   runtimeOptions = RuntimeOptions(
       read_timeout=xxx,  # Timeout baca dalam milidetik (ms)
       connect_timeout=xxx  # Timeout koneksi dalam milidetik (ms)
   )

6. Jika masalah tetap terjadi setelah verifikasi sertifikat SSL dinonaktifkan, atur variabel lingkungan PYTHONHTTPSVERIFY ke 0 untuk menonaktifkan verifikasi sertifikat SSL.

   export PYTHONHTTPSVERIFY=0  # Nonaktifkan verifikasi HTTPS.

7. Periksa sertifikat SSL pada mesin lokal: Pastikan sertifikat SSL pada mesin lokal mutakhir dan lengkap. Anda dapat menggunakan tool seperti certbot untuk memperbarui dan menginstal sertifikat.

   sudo certbot certonly --standalone --rsa-key-size 4096 --agree-tos --email yo**@email.com