API overview
Updated at:
API standards and multilingual preset SDKs
The OpenAPI of this product (MPServerless/2019-06-15) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Service space
|
API |
Title |
Description |
| CreateSpaceWithOrder | Create a service space and pay for the order | Creates a service space and places an order. |
| DescribeSpaces | Query space list information | Query space instance information by spaceId, tenant ID, EMAS project space, or Package Tier. |
| CreateSpace | Create a miniapp service space | Create a miniapp Serverless service space. |
| DeleteSpace | Delete a service Space | Deletes a service space. |
| UpdateSpace | Update a service space | Update a service space. |
| ListSpace | Query the list of service spaces | Lists service spaces. |
Cloud functions
|
API |
Title |
Description |
| CreateFunctionDeployment | Create a cloud function deployment | Creates a function deployment. |
| UpdateHttpTriggerConfig | Update the HTTP trigger configuration of a cloud function | Updates the HTTP trigger configuration for a cloud function. |
| DescribeFunction | Query details of a created cloud function | Queries the details of a cloud function. |
| DescribeHttpTriggerConfig | Query the HTTP trigger configuration of a cloud function | Queries the HTTP trigger configuration of a cloud function. |
| ListFunction | Query the list of created cloud functions | Retrieve a list of created cloud functions. |
| ListFunctionDeployment | Query the list of cloud function deployment orders | Queries a list of function deployments. |
| ListFunctionLog | Query function execution logs | Query the execution logs of aggregation functions. |
| DeployFunction | Trigger function deployment | Trigger function deployment. |
| RunFunction | Execute Function | Execute a function. Synchronous execution supports a maximum duration of 60 seconds. |
Cloud database
|
API |
Title |
Description |
| Collection management and commands | Collection management and commands | |
| DeleteDBCollection | Delete Database Collection | Delete a database collection via the API. |
| RenameDBCollection | Rename a collection | Rename a collection. |
| RunDBCommand | Execute a database command | Execute a database command. |
| Backup and restoration | Backup and restoration | |
| CreateDBRestoreTask | Create a collection restore job | Create a collection restore job. After the restore job is created successfully, a job ID is returned. |
| QueryDBBackupCollections | Query the collection of backups by backup ID | Query a backup collection by backup ID. |
| QueryDBRestoreTaskStatus | Query the status of a collection rollback job | Query the status of a collection rollback job. |
| QueryDBBackupDumpTimes | Query backup time and backup ID | Queries the backup time and backup ID. By default, backup records from the last 7 days are retained. |
| Data import and export | Data import and export | |
| CreateDBExportTask | Create a database export job | Creates a database export task. |
| CreateDBImportTask | Create a database import job | Create a database import job. |
| QueryDBExportTaskStatus | Query Database Export Job Status | Queries the status of a database export job. If the task execution succeeds, a file download link is returned. If it fails, the failure reason is returned. |
| QueryDBImportTaskStatus | Query database import status | Query the database import status. |
Cloud storage
|
API |
Title |
Description |
| RegisterFile | Register File | Register a file. |
| DescribeFileUploadSignedUrl | Obtain the signature required for uploading a file | Retrieves the signed URL required to upload a file. |
| DescribeCdnDomain | Retrieve Alibaba Cloud CDN Configuration | Query an Alibaba Cloud CDN accelerated domain name. |
| SaveCdnDomainConfig | Save Alibaba Cloud CDN configuration | Configure a CDN domain. |
Static website hosting
|
API |
Title |
Description |
| Files | Files | |
| DeleteWebHostingFile | Delete a file from static website hosting | Delete a file from static website hosting. |
| BatchDeleteWebHostingFiles | Batch delete files under static website hosting | Deletes files from static website hosting in bulk. |
| ListWebHostingFiles | Paginate to retrieve static files of a website | Retrieve static website files with paging. |
| DescribeWebHostingFile | Query file details under static website hosting | Query the details of a file under static website hosting. |
| GetWebHostingUploadCredential | Obtain upload credentials for static website hosting | Obtain upload credentials for static website hosting. |
| Domain names | Domain names | |
| BindWebHostingCustomDomain | Add a custom domain name | Binds a custom domain name. |
| UnbindWebHostingCustomDomain | Delete a custom domain name | Deletes a custom domain name. |
| SaveWebHostingCustomDomainConfig | Save Domain Configuration | Save domain configuration. |
| VerifyWebHostingDomainOwner | Authenticate the owner of the web host domain name | Authenticate the owner of the web host domain name. |
| GetWebHostingDomainVerificationContent | Obtain host domain validated content | Obtain the domain ownership validation content. |
| ListWebHostingCustomDomains | Query the custom domain name of the current static website | Query the custom domain names attached to the current static website. |
| RefreshWebHostingCustomDomainCache | Purge Static Website CDN Cache | Purges the Alibaba Cloud CDN cache for a custom accelerated domain name used in static website hosting, so that your newly uploaded files take effect immediately. You can invoke this operation up to three times per hour. |
| Certificates | Certificates | |
| DeleteWebHostingCertificate | Detach Certificate | Detaches the certificate and disables HTTPS access. |
| AttachWebHostingCertificate | AttachWebHostingCertificate | Call the AttachWebHostingCertificate operation to attach a certificate. |
| GetWebHostingCertificateDetail | Query the details of the certificate associated with a custom domain name | Queries the certificate details for a custom domain name. |
| Configuration | Configuration | |
| SaveWebHostingCustomDomainCorsConfig | Configure cross-origin settings for a static website | Configure cross-origin settings for a static website. |
| GetWebHostingConfig | Query static website configuration | Query the static website hosting configuration. |
| ModifyWebHostingConfig | Update static website configuration | Update the static website configuration. |
Management
|
API |
Title |
Description |
| EnableExtension | Enable an extension capability | Enable an extension capability. |
| UpdateServicePolicy | Update permissions | Update permissions. |
| OpenService | Activate service | Activate a Serverless product. |
| OpenWebHostingService | Enable the static website hosting feature | Enables the static website hosting feature. |
| ResetServerSecret | Reset Server Key | Reset the server key for the API. |
| SaveAppAuthToken | Save application authentication token | Authorizes access in ISV mode. |
| DescribeFCOpenStatus | Obtain the FC enabling status | View whether the Alibaba Cloud Function Compute service has been enabled. |
| DescribeServicePolicy | Query permission rules | Query permission rules. |
| ListExtensions | Query extension capabilities | Query extension capabilities. |
| QueryServiceStatus | Query service status | Query the status of a Serverless product service. |
| GetWebHostingStatus | Query the activation status of the static website hosting feature | Query the activation status of the static website hosting feature. |
| CheckMpServerlessRoleExists | Check whether the Mp role exists | Checks whether an Alibaba Cloud user has the required permission. |
Open platform configuration
|
API |
Title |
Description |
| AddDingtalkOpenPlatformConfig | Add DingTalk Open Platform configuration | Add DingTalk Open Platform configuration. |
| SaveAntOpenPlatformConfig | Save the Alipay Open Platform configuration | Save the Alipay Open Platform configuration. |
| SaveWechatOpenPlatformConfig | Save the WeChat Open Platform configuration | Save the WeChat Open Platform configuration. |
| DeleteAntOpenPlatformConfig | Delete Alipay Open Platform configuration | Delete Alipay Open Platform configuration. |
| DeleteDingtalkOpenPlatformConfig | Delete the DingTalk Open Platform configuration | Delete the DingTalk Open Platform configuration. |
| DeleteWechatOpenPlatformConfig | Delete the WeChat Open Platform configuration | Delete the WeChat Open Platform configuration. |
| UpdateDingtalkOpenPlatformConfig | Update the DingTalk Open Platform configuration | Update the DingTalk Open Platform configuration. |
| DescribeSpaceClientConfig | Query the configuration details of a service space | Query the details of a service space. |
| ListOpenPlatformConfig | Query Alipay and WeChat Open Platform configuration | Query the Alipay and WeChat Open Platform configuration. |
| ListDingtalkOpenPlatformConfigs | Query DingTalk Open Platform Configuration | Query DingTalk Open Platform configuration. |
Security domain names
|
API |
Title |
Description |
| AddCorsDomain | Add CORS Domain Name | Adds a CORS domain to a service space. |
| DeleteCorsDomain | Delete a CORS domain name | Deletes a CORS domain. |
| ListCorsDomains | Query CORS domain names | Query CORS domain names. |
Resource usage and thresholds
|
API |
Title |
Description |
| QuerySpaceSpecDetail | Query Package Tier Details | Retrieves plan details based on its specifications. |
| QuerySpaceUsage | Query resource usage | Retrieves details about service space resource usage. |
| QuerySpaceConsumption | Query resource consumption for a space | Query the current month's usage and consumption of the service space. |
| DescribeResourceQuota | Query the resource thresholds of a service space | Queries the resource thresholds for a service space. |
Others
|
API |
Title |
Description |
| CreateFunction | Create a Cloud Function | Create a cloud function. |
| DeleteFile | Delete a file | Delete a file. |
| DeleteFunction | Delete a cloud function | Delete a cloud function. |
| DescribeResourceUsage | Query resource usage | Query resource usage. |
| ListFile | Query file list | Query the file list. |
| UpdateFunction | Update function information | Update a function. |
Is this page helpful?