步驟一：新增API

1. 登錄數據管理DMS 5.0。

2. 在頂部菜單欄中，選擇集成與開發 > 數據應用 > 數據服務。

   說明

   若您使用的是極簡模式的控制臺，請單擊控制臺左上角的圖標，選擇全部功能 > 集成與開發 > 數據應用 > 數據服務。

3. 進入數據服務頁面后，在左側導航欄，單擊API開發。

4. 進入API管理頁面，單擊右上角的新增API。

5. 配置屬性配置、執行配置、請求參數、返回參數信息。

   屬性配置

   參數	說明
   API名稱	數據API的名稱，支持以漢字，英文，數字或下劃線（_）組成，且只能以英文和漢字開頭，長度為4~100個字符。
   描述	用于API的邏輯描述。例如描述API返回的數據，API的應用場景。
   路徑	路徑為API調用地址的組成部分。 路徑只能以/開頭，僅支持以英文、數字、下劃線（_）、橫杠（-）組成，例如/item/add。 API調用地址結構示例：https://{分組域名}{路徑}。 路徑定義為/item/test、分組域名為xxxx-cn-hangzhou.alicloudapi.com，則最終API調用地址為https://xxxx-cn-hangzhou.alicloudapi.com/item/test。
   返回格式	目前僅支持以JSON格式返回API的數據。
   請求方式	通用的API請求方式，支持的選項： POST GET 本示例的請求方式為GET。
   超時時間	執行API時的最大耗時，單位為毫秒，默認值為10000。 調用API時，當執行時間超過該參數值，將返回超時錯誤。該值最大允許30000（毫秒），即30秒。
   返回最大記錄數	調用API允許返回的最大記錄數。默認值為1000。 說明 當實例處于安全協同管控模式下，安全規則中同樣定義了返回最大記錄數，此時，API的最大記錄數，不允許超過安全規則中的返回最大記錄數。
   返回字段元數據	根據您的業務需求選擇是或否，若您選擇是，則在調用API允許返回字段的類型、長度等基本信息。
   返回執行詳情	根據您的業務需求選擇是或否。

   執行配置

   參數	說明
   實例查詢類型	實例查詢的類型，支持的權限： 單實例查詢：僅查詢一個數據庫實例。可以通過表引導模式和SQL腳本模式定義API。 跨實例查詢：通過編寫跨數據庫查詢DSQL，來實現多個不同實例數據的關聯查詢，詳細信息，請參見官方文檔。僅支持SQL腳本模式定義API。
   數據源	待查詢的數據庫。通過輸入關鍵字，可查詢當前用戶有查詢權限的數據庫。 該參數僅當實例查詢類型為單實例查詢模式時顯示。
   配置方式	選擇API的配置方式，支持的選項： 表引導模式：通過可視化的方式選擇表、字段，定義API的數據查詢配置。 腳本模式：通過手動編寫SQL腳本+變量的方式來定義API的數據查詢配置。 說明 從表引導模式切換為腳本模式時，系統將提示切換模式將清空請求參數和返回參數。 該參數僅當實例查詢類型為單實例查詢模式時顯示。
   選擇表	表引導模式下，可選擇需要執行查詢的表。可通過輸入關鍵字快捷查找表。 該參數僅當配置方式為表引導模式時顯示。
   字段列表	該字段列表會展示當前選擇的數據表中的所有字段，您可以通過勾選的方式，快速定義目標字段作為API的請求參數和返回參數。 該參數僅當配置方式為表引導模式時顯示。
   查詢SQL	您可以在此編寫查詢SQL。 SQL腳本支持變量的定義。通過定義變量，可映射成為API的請求參數。變量在SQL中，以${變量名}的方式書寫。例如${category}，完整帶變量的SQL為select item_id, item_name from ex_item where category=${category}。 在編寫完成SQL腳本后，需要單擊解析腳本按鈕解析腳本的正確性以及變量定義。解析成功后，系統會自動基于定義的變量作為請求參數。 該參數僅在以下兩種情況顯示： 跨實例查詢，且只支持DSQL語法，更多信息，請參見DSQL語法。 單實例查詢的腳本模式，語法需要與選擇的數據源語法類型一致。

   請求參數

   參數	說明
   參數名稱	調用API時的入參名稱，支持英文、數字、下劃線（_）、橫杠（-），且只能以英文或下劃線（_）開頭，1~50個字符，默認為字段名。
   變量名稱或字段名稱	這里顯示該參數來源，可來源于表引導模式的字段，也可來源于腳本模式的變量。
   不能為空	該項定義請求參數在調用時，是否為必需項。勾選則代表請求參數為必須輸入項。 說明 當配置方式為腳本模式時，所有參數均為必需，不可去勾選；表引導模式時，則可選。
   描述	用于描述該請求參數。
   數據類型	包括字符串、整型、浮點三種基本類型，默認為字符串。 此參數的作用為：在調用時將校驗請求參數值是否符合對應的類型，且在執行API時，保障SQL的正常執行。
   示例值	請求參數的示例值。 在生成SDK和文檔時，供使用者閱讀，便于正確調用API。
   默認值	當請求參數為可選時，如果存在該定義，則以該定義作為入參執行API。

   返回參數

   說明

   當前只支持讀取表數據，因此返回參數列表的組合也代表了所執行數據查詢的二維表結構。

   參數	說明
   參數名稱	返回參數名稱，支持英文、數字、下劃線（_）、橫杠（-），且只能以英文或下劃線（_）開頭，1~50個字符，默認為字段名。
   變量名稱或字段名稱	僅顯示返回的字段名。
   描述	用于描述返回參數。
   數據類型	包括字符串、整型、浮點三種基本類型，默認為字符串。 此參數的作用為：系統把查詢后的數據，按照此處定義進行數據轉換，最終將數據寫入返回的JSON中。
   示例值	返回參數的示例值。在生成SDK和文檔時，供使用者閱讀，便于正確了解API返回信息。

6. 單擊保存按鈕，完成新增API操作。

   說明

   您也可以單擊發布按鈕可直接發布API。

步驟二：發布API

在發布API后，API處于上線狀態，此時，才可在應用中使用SDK進行調用。

在API開發頁簽，單擊目標API操作列下的發布，單擊確認，完成發布。

步驟三：測試API

API發布后，您可以在API測試頁簽下，查看調用API的返回結果是否符合預期。

1. 在API測試頁簽下，單擊下拉列表選擇目標API名稱。

2. 輸入對應的請求參數值，單擊測試，系統將以輸入的參數值執行API。

   執行后，右側會顯示執行信息以及執行的返回結果（以表格和JSON兩種方式呈現）。

   

后續步驟

調用API

其他操作