API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(MPServerless/2019-06-15)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 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访问。
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 查询资源使用量 查询资源使用量。