API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

本产品(小程序Serverless/2019-06-15)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

服务空间

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访问。
AttachWebHostingCertificateAttachWebHostingCertificate调用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查询资源使用量查询资源使用量。