DataService Studio API - DataWorks - Alibaba Cloud Dokümantasyon Merkezi

Data Map, mevcut kiracı içindeki tüm çalışma alanlarında DataService Studio API'lerini bulmanızı sağlayarak verimli keşif imkanı sunar.

API arama sayfası

Data Map sayfasına gidin.

DataWorks konsolu adresinde oturum açın. Hedef bölgede sol gezinme bölmesinden Data Governance > Data Map seçeneğine tıklayın. Görüntülenen sayfada Go to Data Map öğesine tıklayın.
Arama kutusunun üstünde API kategorisini seçin.

Arama çubuğunun sol tarafındaki arama türü açılır menüsü üç gruptan oluşur: Code, API ve Dataset. API grubundaki API seçeneğini belirleyin.

API bulma

API kategorisinin altındaki arama kutusuna API ID, APIPath, API Name veya API Description gibi anahtar kelimeler girin.

Bir anahtar kelime yazdığınızda açılan listede en çok eşleşen ilk 10 API gösterilir.
Aradığınız API açılır listede yoksa tüm eşleşmeleri görüntülemek için Search düğmesine tıklayın.
Sol bölmede arama sonuçlarını API Type, Workspace veya Owner filtrelerine göre daraltabilirsiniz.
Hedef API'yi bulduktan sonra ayrıntılar sayfasına gitmek için üzerine tıklayın. Daha fazla bilgi için bkz. API ayrıntılarını görüntüleme.

API ayrıntıları

API ayrıntıları sayfasında API'nin Basic Information, Technical Information, Parameter Information, Sample Response ve Instructions bölümleri yer alır. API bir Script Mode API ise ek olarak Code sekmesi de görüntülenir.

API ayrıntıları sayfası üç alana ayrılır: Üstteki ① numaralı alanda API adı, açıklaması ve düzenleme giriş noktası bulunur. Sol paneldeki ② numaralı alanda API'nin temel ve teknik bilgileri gösterilir. Sağ paneldeki ③ numaralı alanda parametre bilgileri, yanıt örnekleri, veri soy bilgisi ve kullanım notları gibi ayrıntılı içerik sekmeler halinde sunulur. Aşağıdaki tabloda her alan açıklanmıştır.

Alan	Description
①	API'nin çalışma alanında düzenleme penceresini açmak için Edit API seçeneğine tıklayın. Daha fazla bilgi için bkz. API test etme, yayınlama ve sürüm yönetimi ve Harici API hizmetini kaydetme. Not Hesabınız API'nin çalışma alanının bir üyesi değilse çalışma alanı sahibiyle iletişime geçin ve hesabınızı Developer rolüne sahip bir üye olarak eklemelerini isteyin. Daha fazla bilgi için bkz. Çalışma alanı düzeyindeki hizmetler için izinleri yönetme.
②	Bu alanda aşağıdaki API bilgileri gösterilir: Basic Information: API'nin Views, Number of Calls, API ID, Workspace, Owner, Created At, Last Updated ve Description gibi ayrıntıları içerir. Technical Information: API Type, Request Method, Response Type, Data Source Type, Data Source Name ve Table Name gibi ayrıntıları içerir.
③	Bu alanda aşağıdaki API bilgileri gösterilir: Parameter Information: API'nin Request Parameters ve Response Parameters değerlerini gösterir. Request Parameters: Common Request Parameters ve API Request Parameters için Parameter Name, Parameter Type, Parameter Position, Sample Value, Default Value, Description ve Label ayrıntılarını içerir. Response Parameters: Common Response Parameters ve API Response Parameters için Parameter Name, Parameter Type, Sample Value ve Description ayrıntılarını içerir. Sample Response: Bir API'yi yayınlamadan önce test ederseniz ve test sırasında Save the correct response example automatically seçeneğini belirlerseniz örnek yanıt test sonuçlarına göre güncellenir. Daha fazla bilgi için bkz. API test etme. Sample Response bölümündeki içerik ve yapı API'nin yanıt biçimini gösterir. Lineage Information: Veri tabloları, API'ler ve uygulamalar arasındaki tam veri soy bilgisini gösterir. DataService Studio API'leri için upstream veri soy bilgisi aşağıdaki veri kaynağı türlerini destekler: Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0 ve AnalyticDB for PostgreSQL. Not API Generation, bir veri kaynağını veya tabloyu kapsülleyerek oluşturulur. Bu nedenle veri soy bilgisi veri tablolarını, API'yi ve uygulamaları içerir. Register API, bir arka uç adresini kapsülleyerek oluşturulur. Bu nedenle veri soy bilgisi yalnızca API'yi ve uygulamaları içerir. Veri soy bilgisi T+1 esasına göre oluşturulur ve güncellenir. Instructions: Notları Edit seçeneğiyle düzenleyebilir veya geçmiş değişiklikleri incelemek için View Versions seçeneğini kullanabilirsiniz. Code: Bu sekme yalnızca API bir Script Mode API olduğunda görünür. Geliştirici tarafından yazılan özel sorgu kodunu (SQL gibi) görüntülemenize olanak tanır. Sekme diğer API türleri (sihirbaz modu API'ler, kayıtlı API'ler veya orkestre edilmiş hizmet API'leri) için görüntülenmez; sihirbaz modu API'ler için DataService API geliştirme düzenleyicisinde SQL kodunu inceleyebilirsiniz. Not Data Map genel arama kutusunda bir kod parçacığı aratarak script-mode bir API bulursanız sistem otomatik olarak Code sekmesine gider.