本產品(
小程序Serverless/2019-06-15
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(78410016550),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
服務空間
API | 標題 | API概述 |
---|---|---|
CreateSpaceWithOrder | 創建服務空間并支付下單 | 創建服務空間并下單。 |
DescribeSpaces | 查詢空間列表信息 | 根據 spaceId、租戶ID、EMAS項目空間或者套餐規格來查詢空間實例信息。 |
CreateSpace | 創建小程序服務空間 | 創建小程序Serverless服務空間。 |
DeleteSpace | 刪除服務空間 | 刪除服務空間。 |
UpdateSpace | 更新服務空間 | 更新服務空間。 |
ListSpace | 查詢服務空間列表 | 查詢服務空間列表。 |
云函數
API | 標題 | API概述 |
---|---|---|
CreateFunction | 創建云函數 | 創建云函數。 |
CreateFunctionDeployment | 創建云函數部署單 | 創建云函數部署單。 |
DeleteFunction | 刪除云函數 | 刪除云函數。 |
UpdateFunction | 更新函數信息 | 更新函數信息。 |
UpdateHttpTriggerConfig | 更新云函數的HTTP觸發配置 | 更新云函數的HTTP觸發配置。 |
DescribeFunction | 查詢已創建的云函數詳情 | 查詢已創建的云函數詳情。 |
DescribeHttpTriggerConfig | 查詢云函數的HTTP觸發配置 | 查詢云函數的HTTP觸發配置。 |
ListFunction | 查詢已創建的云函數列表 | 查詢已創建的云函數列表。 |
ListFunctionDeployment | 查詢云函數部署單列表 | 查詢云函數部署單列表。 |
ListFunctionLog | 查詢函數執行日志 | 查詢函數執行日志。 |
DeployFunction | 觸發函數部署 | 觸發函數部署。 |
RunFunction | 執行函數 | 執行函數,同步執行最多支持60秒。 |
云數據庫
API | 標題 | API概述 |
---|---|---|
集合管理與命令 | 集合管理與命令 | |
DeleteDBCollection | 刪除數據庫集合 | 接口刪除數據庫集合。 |
RenameDBCollection | 重命名集合 | 重命名集合。 |
RunDBCommand | 執行數據庫命令 | 執行數據庫命令。 |
備份與回檔 | 備份與回檔 | |
CreateDBRestoreTask | 創建集合回檔任務 | 創建集合回檔任務。創建回檔任務成功后,會返回任務ID。 |
QueryDBBackupCollections | 根據備份ID來查詢備份的集合 | 根據備份ID來查詢備份的集合。 |
QueryDBRestoreTaskStatus | 查詢集合回檔任務狀態 | 查詢集合回檔任務狀態。 |
QueryDBBackupDumpTimes | 查詢備份時間和備份ID | 查詢備份時間和備份ID,默認保存最近7天的備份記錄。 |
數據導入與導出 | 數據導入與導出 | |
CreateDBExportTask | 創建數據庫導出任務 | 創建數據庫導出任務。 |
CreateDBImportTask | 創建數據庫導入任務 | 創建數據庫導入任務。 |
QueryDBExportTaskStatus | 查詢數據庫導出任務狀態 | 查詢數據庫導出任務狀態,若任務執行成功會同時返回文件下載鏈接,若失敗會返回失敗原因。 |
QueryDBImportTaskStatus | 查詢數據庫導入狀態 | 查詢數據庫導入狀態。 |
云存儲
API | 標題 | API概述 |
---|---|---|
DeleteFile | 刪除文件 | 刪除文件。 |
RegisterFile | 注冊文件 | RegisterFile注冊文件。 |
DescribeFileUploadSignedUrl | 獲取上傳文件需要的簽名 | 獲取上傳文件需要的簽名。 |
ListFile | 查詢文件列表 | 查詢文件列表。 |
DescribeCdnDomain | 獲取CDN配置 | 查詢CDN域名。 |
SaveCdnDomainConfig | 保存CDN配置 | 配置CDN。 |
靜態網站托管
API | 標題 | API概述 |
---|---|---|
文件 | 文件 | |
DeleteWebHostingFile | 刪除靜態網站托管下的文件 | 刪除靜態網站托管下的文件。 |
BatchDeleteWebHostingFiles | 批量刪除靜態網站托管下的文件 | 批量刪除靜態網站托管下的文件。 |
ListWebHostingFiles | 分頁獲取網站靜態文件 | 分頁獲取網站靜態文件。 |
DescribeWebHostingFile | 查詢靜態網站托管下的文件詳情 | 查詢靜態網站托管下的一個文件詳情。 |
GetWebHostingUploadCredential | 獲取靜態網站托管的上傳文件憑證 | 獲取靜態網站托管的上傳文件憑證。 |
域名 | 域名 | |
BindWebHostingCustomDomain | 添加自定義域名 | 添加自定義域名。 |
UnbindWebHostingCustomDomain | 刪除一個自定義域名 | 刪除一個自定義域名。 |
SaveWebHostingCustomDomainConfig | 保存域名配置 | 保存域名配置。 |
VerifyWebHostingDomainOwner | 驗證 Web 主機域名所有者 | 驗證Web主機域名所有者。 |
GetWebHostingDomainVerificationContent | 獲取主機域名驗證內容 | 獲取域名歸屬校驗內容。 |
ListWebHostingCustomDomains | 查詢當前靜態網站自定義域名 | 查詢當前靜態網站綁定的自定義域名。 |
RefreshWebHostingCustomDomainCache | 刷新靜態網站CDN緩存 | 用于刷新靜態網站托管自定義加速域名 CDN 緩存,讓您最新上傳的文件立即生效。每小時限制調用三次。 |
證書 | 證書 | |
DeleteWebHostingCertificate | 解綁證書 | 解綁證書,關閉HTTPS訪問。 |
AttachWebHostingCertificate | AttachWebHostingCertificate | 調用AttachWebHostingCertificate綁定證書。 |
GetWebHostingCertificateDetail | 查詢自定義域名關聯的證書詳情 | 查詢自定義域名關聯的證書詳情。 |
配置 | 配置 | |
SaveWebHostingCustomDomainCorsConfig | 設置靜態網站的跨域配置 | 設置靜態網站的跨域配置。 |
GetWebHostingConfig | 查詢靜態網站配置 | 查詢靜態網站配置。 |
ModifyWebHostingConfig | 更新靜態網站配置 | 更新靜態網站配置。 |
管理
API | 標題 | API概述 |
---|---|---|
EnableExtension | 開通擴展能力 | 開通擴展能力。 |
UpdateServicePolicy | 更新權限 | 更新權限。 |
OpenService | 開通服務 | 開通Serverless產品。 |
OpenWebHostingService | 開通靜態網站托管功能 | 開通靜態網站托管功能。 |
ResetServerSecret | 重置服務端密鑰 | 接口重置服務端密鑰。 |
SaveAppAuthToken | 保存應用驗證令牌 | 授權isv模式訪問。 |
DescribeFCOpenStatus | 獲取 FC 開啟狀態 | 查看是否已開通阿里云函數計算服務。 |
DescribeServicePolicy | 查詢權限規則 | 查詢權限規則。 |
ListExtensions | 查詢擴展能力 | 查詢擴展能力。 |
QueryServiceStatus | 查詢服務狀態 | 查詢Serverless產品服務狀態。 |
GetWebHostingStatus | 查詢靜態網站托管功能開通狀態 | 查詢靜態網站托管功能開通狀態。 |
CheckMpServerlessRoleExists | 檢查 Mp 角色是否存在 | 檢查阿里云用戶是否具有權限。 |
開放平臺配置
API | 標題 | API概述 |
---|---|---|
AddDingtalkOpenPlatformConfig | 添加釘釘開放平臺配置 | 添加釘釘開放平臺配置。 |
SaveAntOpenPlatformConfig | 保存支付寶開放平臺配置 | 保存支付寶開放平臺配置。 |
SaveWechatOpenPlatformConfig | 保存微信開放平臺配置 | 保存微信開放平臺配置。 |
DeleteAntOpenPlatformConfig | 刪除支付寶開放平臺配置 | 刪除支付寶開放平臺配置。 |
DeleteDingtalkOpenPlatformConfig | 刪除釘釘開放平臺配置 | 刪除釘釘開放平臺配置。 |
DeleteWechatOpenPlatformConfig | 刪除微信開放平臺配置 | 刪除微信開放平臺配置。 |
UpdateDingtalkOpenPlatformConfig | 更新釘釘開放平臺配置 | 更新釘釘開放平臺配置。 |
DescribeSpaceClientConfig | 查詢服務空間配置詳情 | 查詢服務空間詳情。 |
ListOpenPlatformConfig | 查詢支付寶、微信開放平臺配置 | 查詢支付寶、微信開放平臺配置。 |
ListDingtalkOpenPlatformConfigs | 查詢釘釘開放平臺配置 | 查詢釘釘開放平臺配置。 |
安全域名
API | 標題 | API概述 |
---|---|---|
AddCorsDomain | 添加CORS域名 | 為服務空間添加CORS域名。 |
DeleteCorsDomain | 刪除CORS域名 | 刪除CORS域名。 |
ListCorsDomains | 查詢CORS域名 | 查詢CORS域名。 |
資源用量與閾值
API | 標題 | API概述 |
---|---|---|
QuerySpaceSpecDetail | 查詢套餐規格詳情 | 根據套餐規格查詢套餐詳情。 |
QuerySpaceUsage | 查詢資源用量 | 查詢服務空間資源用量詳情。 |
QuerySpaceConsumption | 查詢空間資源消費 | 查詢服務空間的當月用量消費。 |
DescribeResourceQuota | 查詢服務空間資源的閾值 | 查詢服務空間資源的閾值。 |
DescribeResourceUsage | 查詢資源使用量 | 查詢資源使用量。 |