OpenAPI Explorer'da Alibaba Cloud API işlemlerini nasıl çevrimiçi hata ayıklayacağınızı öğrenin.
Bir Alibaba Cloud hesabı oluşturun
API çağrıları için bir Alibaba Cloud hesabı gerekir. Hesabınız yoksa Alibaba Cloud resmi web sitesinde kaydolun.
Alibaba Cloud hizmetlerini etkinleştirin
Kullanmak istediğiniz Alibaba Cloud hizmetlerini etkinleştirin. Aşağıdaki örnekte SMS kullanılmıştır:
User Center adresine gidin, Short Message Service'i arayın ve Activate seçeneğine tıklayın.
Hizmet konsoluna (örneğin SMS console) gidin ve Activate seçeneğine tıklayın.
API işlemlerini çağırmadan önce bir Alibaba Cloud hizmetini etkinleştirmeniz gerekir.
Bir API işlemini çevrimiçi hata ayıklama
OpenAPI Explorer oturumunu açın, ECS gibi etkinleştirilmiş bir Alibaba Cloud hizmeti seçin ve ardından Debug seçeneğine tıklayın.
Hata ayıklanacak API işlemini seçin (örneğin, ECS için DescribeInstanceTypeFamilies). Parameters bölümünde, Document sekmesinde açıklanan değerleri girin ve ardından Initiate Call seçeneğine tıklayın. OpenAPI çevrimiçi hata ayıklama.
Yanıt
Response sekmesi, çağrı tarafından döndürülen HTTP status code ve verileri gösterir.
Bu sekme ayrıca Request Header ve Response Header bilgilerini de görüntüler.
Başarılı çağrı
Başarılı bir çağrı, 200 HTTP durum kodunu ve bir JSON yanıtını döndürür. Her parametre, API belgelerinde (örneğin DescribeInstanceTypeFamilies referansında) açıklanmıştır.
Başarısız çağrı
Başarısız bir çağrı, 4xx aralığında bir HTTP durum kodu döndürür. Standart ağ geçidini kullanmayan birkaç hizmet dışında, Alibaba Cloud API'leri tek tip bir hata yanıtı yapısı kullanır. Aşağıdaki örnek, ECS'nin RunInstances işlemi için hata biçimini göstermektedir:
{
"RequestId": "7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Message": "The specified endpoint cant operate this region. Please use API DescribeRegions to get the appropriate endpoint, or upgrade your SDK to latest version.(from POP)",
"Recommend": "https://api.alibabacloud.com/troubleshoot?q=InvalidOperation.NotSupportedEndpoint&product=Ecs&requestId=7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"HostId": "ecs-cn-hangzhou.aliyuncs.com",
"Code": "InvalidOperation.NotSupportedEndpoint"
}|
Parametre |
Açıklama |
|
RequestId |
Genel olarak benzersiz olan istek kimliği. Sorunların tespit edilmesine yardımcı olması için bu |
|
HostId |
Hatanın oluştuğu hizmet uç noktası. Bu örnekte, Çin (Hangzhou) bölgesindeki ECS uç noktasıdır. |
|
Code |
Hata türü için kısa bir tanımlayıcı. Çözümler için bu kodu Alibaba Cloud belgelerinde arayın. Bu örnekte, uç nokta hedef bölgeyi desteklememektedir. |
|
Message |
Ayrıntılı hata mesajı. Bu örnekte, uç nokta seçilen bölgeyi desteklememektedir. Geçerli bir uç nokta bulmak için |
|
Recommend |
Bir tanılama URL'si. Çözümler için bu bağlantıyı açarak OpenAPI Troubleshoot sayfasına gidin. |
Hataları gidermek için OpenAPI Troubleshoot kullanın.
SDK örnek kodu
SDK sample code sekmesinde bir SDK version ve dil seçin, ardından Run Example seçeneğine tıklayın.
SDK sürümlerini karşılaştırmak için View Version Differences, kodu indirmek için Download Full Project seçeneklerine tıklayabilir veya oluşturma modunu değiştirmek için Generate Example in Common Mode anahtarını açıp kapatabilirsiniz.
CLI örneği
CLI example sekmesinde, komutu çevrimiçi olarak hata ayıklamak için çalıştırma düğmesine tıklayın.
Çağrı geçmişi
Call History sekmesi, önceki API çağrılarınızı listeler. Parametreleri inceleyin ve bir çağrıyı yeniden çalıştırmak için Redebug seçeneğine tıklayın. Bir çağrının status durumu başarısız ise, nedeni belirlemek için Diagnose seçeneğini kullanın.
Hata kodları
Error Codes sekmesi, olası hataları ve açıklamalarını listeler. İlgili belgeleri, forum tartışmalarını ve desteği sağlayan tanılama sayfasını açmak için Diagnose seçeneğine tıklayın.
Örneğin, geçersiz bir RegionId girdiğinizde 404 HTTP durum kodu, InvalidRegionId.NotFound hata kodu ve The RegionId provided does not exist in our records. mesajı döndürülür.