前提條件

• 已創建工作組，具體操作，請參見新建工作組。

• 已創建云計算資源，具體操作，請參見新建云計算資源。

• 已創建應用，具體操作，請參見新建應用。

• 已通過查看云計算資源的物理表更新緩存表，具體操作，請參見查看物理表。

背景信息

本文以RDS MySQL云數據庫創建API為例。

操作步驟

1. 登錄數據資源平臺控制臺。

2. 在頁面左上角，單擊圖標，選擇協同。

3. 在頂部菜單欄，單擊圖標，選擇目標工作組，單擊資產加工。

4. 在左側導航欄，單擊圖標，選擇API開發 > 數據服務API。

5. 在數據服務API頁面右上角，單擊創建API。

6. 在數據服務API-創建頁面，開始創建API。

   1. 在基礎信息區域，設置API的基礎信息。

      參數	說明
      API名稱	API的名稱，自定義即可。
      所屬應用	選擇API的歸屬應用。單擊新增應用，可新建應用，更多信息請參見新建應用。
      服務協議	選擇服務的協議類型。
      API Path	API調用時展示的固定路徑，默認自動生成。
      調用認證方式	簡單身份認證和加密身份認證兩種方式，更多信息，請參見認證方式說明。 簡單身份認證：適用于工作組內、測試等場景下的API調用，工作組內調用時用API歸屬應用的AppCode調用。 加密身份認證：通過加密算法計算一個簽名并放在請求的Header中即可調用API，具備更高的安全性，適用于API共享后，應用開發場景下API的調用。
      標簽	添加API的應用模塊標簽，可選項，便于后續統計分析。 添加方式：單擊加號，在添加標簽對話框，選擇應用及模塊標簽，單擊確認。
      描述	自定義API的描述信息，必填。

   2. 在參數配置區域，配置API參數。

      參數	說明
      云計算資源	選擇云計算資源。 說明 若在列表中無法選中目標云計算資源名稱，請單擊前往云計算資源管理，確認目標云計算資源的連通性。
      源數據表	選擇云計算資源下的數據表。
      服務資源組	選擇服務資源組。 說明 上線后API的測試和調用會占用資源組，請根據資源組的規格和占用情況，選擇適合的服務資源組。
      新建模式	新建模式選擇向導模式。
      返回參數	在返回參數區域，選中需要返回的字段。 （可選）在返回參數的函數列單擊添加，可為對應字段增加相應的函數。各數據類型對應的函數說明如表數據類型對應的函數所示。
      返回參數（自定義Header）	（可選）在返回參數（自定義Header）區域，單擊新增參數，填寫Header返回參數的KEY、VALUE和描述信息。
      請求參數	（可選）在請求參數區域，單擊新增參數，填寫請求參數的字段名稱、參數名稱、條件、是否必填、默認值、授權時篩選等。 說明 授權時篩選若選擇是，在授權頁面，會展示授權過濾配置項，具體操作，請參見授權API。
      配置參數	（可選）打開配置參數開關，配置API參數。 在配置參數區域，選中返回分頁結果，可根據需要設置返回結果分頁索引、分頁大小。 說明 當返回結果有可能超過1000條記錄時，請選擇返回結果分頁，否則最多返回1000條記錄。 單擊排序字段，添加排序字段，設置返回結果按照排序字段、排序方式排列。 單擊分組字段，添加分組字段，設置返回結果按照分組字段進行分組展示。
      過濾器	（可選）打開過濾器開關，設置信息模塊展示隱藏，更多信息，請參見API結果過濾器。

      數據類型對應的函數

      數據類型	函數	含義
      數字型（INTEGER、DOUBLE、DECIMAL）、BINARY類型、時間類型（TIME）	AVG	平均數
      	COUNT	計數
      	MAX	最大值
      	MIN	最小值
      	SUM	求和
      	VARIANCE	方差
      	STDDEV	標準差
      字符型（STRING）、BINARY類型、時間類型（TIME）	LOWER	大寫字符轉小寫
      	UPPER	小寫字符轉大寫
      	REPLACE	替換
      	SUBSTR	截取
      	LPAD	左側添加指定字符
      	RPAD	右側添加指定字符
      	LENGTH	字符串長度
      日期型（DATE、DATETIME）、時間類型（TIME）	DAY	日，返回日期的當月天數
      	MONTH	月，返回日期的月份
      	YEAR	年，返回日期的年份
      	WEEKDAY	周，返回代表一周中第幾天的整數
      	CURRENT	返回當前日期

   3. 測試API：單擊開始測試，核對返回內容。

   4. 配置API流量控制。

      參數	說明
      API最大調用QPS	API最大調用QPS應為不大于10000的正整數。當服務資源組設置為“公共資源組”時，API最大調用QPS只能為1。更多信息，請參考API流量控制支持的參數。
      超時配置	請選擇API單次響應超時時間。當服務資源組設置為“公共資源組”時，API單次響應超時時間限制，最大支持10s。
      開啟緩存	打開開啟緩存開關，API調用會請求緩存。
      緩存時長	當緩存開啟后，可以手動設置緩存失效時間，緩存時長上限為3600秒。

7. API參數配置完成后，單擊保存或保存并上線。

   在API資源列表，可查看新建的API。

相關操作

后續步驟

API創建完成后，需要對API進行上線操作，具體操作，請參見上線API。