API standards and multilingual preset SDKs
The OpenAPI of this product (FC/2023-03-30) uses the ROA 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.
Snapshot
|
API |
Title |
Description |
| GetSnapshot | Retrieve snapshot configuration information | Retrieves snapshot information. |
| ListSnapshots | List snapshots | Lists snapshot information. |
| DeleteSnapshot | Delete a snapshot resource | Deletes a user MicroSandbox snapshot. |
| CreateSnapshot | Create a snapshot resource | Creates a user snapshot from a normal and unexpired micro-sandbox session. |
Resource group
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group of a Function Compute resource. |
Region
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries the regions where Function Compute 3.0 is available. |
Custom domain name
|
API |
Title |
Description |
| CreateCustomDomain | CreateCustomDomain | Creates a custom domain name. |
| DeleteCustomDomain | DeleteCustomDomain | Deletes a custom domain name. |
| GetCustomDomain | GetCustomDomain | Retrieves the configuration of a custom domain name. |
| ListCustomDomains | ListCustomDomains | Retrieves a list of custom domain names. |
| UpdateCustomDomain | UpdateCustomDomain | Updates a custom domain name. |
Function
|
API |
Title |
Description |
| DeleteFunctionVersion | DeleteFunctionVersion | Deletes a function version. |
| GetFunctionCode | GetFunctionCode | Retrieves the details of a function code package. |
| ListFunctionVersions | ListFunctionVersions | Lists the versions of a specified function. |
| PublishFunctionVersion | PublishFunctionVersion | Publishes a function version. |
| CreateFunction | Create a function | Creates a function by calling the CreateFunction operation. |
| DeleteFunction | DeleteFunction | Deletes a function. |
| GetFunction | Get function | Retrieves function information. |
| ListFunctions | List functions | Retrieves a list of functions. |
| InvokeFunction | InvokeFunction | Invokes a function. |
| UpdateFunction | Update a function | Updates function information. |
| EnableFunctionInvocation | EnableFunctionInvocation | The EnableFunctionInvocation operation allows a function to be invoked and resumes the creation of provisioned instances. This operation is currently in private preview. |
| DisableFunctionInvocation | DisableFunctionInvocation | Disables function invocations. You can also stop all ongoing requests. When a function is disabled, new instances cannot be created and provisioned instances are destroyed. This OpenAPI is in beta. |
Alias
|
API |
Title |
Description |
| DeleteAlias | DeleteAlias | Deletes an alias. |
| GetAlias | GetAlias | Retrieves information about an alias. |
| ListAliases | ListAliases | Lists aliases. |
| UpdateAlias | UpdateAlias | Updates an alias. |
| CreateAlias | CreateAlias | Creates an alias. |
Trigger
|
API |
Title |
Description |
| CreateTrigger | CreateTrigger | Creates a trigger. |
| DeleteTrigger | DeleteTrigger | Deletes the specified trigger. |
| GetTrigger | GetTrigger | Retrieves the details of a specified trigger. |
| ListTriggers | ListTriggers | Lists the triggers for a specified function. |
| UpdateTrigger | UpdateTrigger | Updates the information of a trigger. |
Function async configuration
|
API |
Title |
Description |
| DeleteAsyncInvokeConfig | DeleteAsyncInvokeConfig | Deletes an asynchronous invocation configuration. |
| GetAsyncInvokeConfig | GetAsyncInvokeConfig | Retrieves the asynchronous invocation configuration of a specified function. |
| ListAsyncInvokeConfigs | ListAsyncInvokeConfigs | Lists the asynchronous invocation configurations for one or more functions. |
| PutAsyncInvokeConfig | PutAsyncInvokeConfig | Creates or updates the asynchronous invocation configuration for a function. |
Provisioned function configuration
|
API |
Title |
Description |
| DeleteProvisionConfig | DeleteProvisionConfig | Deletes a provisioned configuration. |
| GetProvisionConfig | GetProvisionConfig | Retrieves the provisioned configuration. |
| ListProvisionConfigs | ListProvisionConfigs | Retrieves a list of provisioned configurations. |
| PutProvisionConfig | PutProvisionConfig | Creates a provisioned configuration. |
Function concurrency configuration
|
API |
Title |
Description |
| DeleteConcurrencyConfig | DeleteConcurrencyConfig | Deletes a concurrency configuration. |
| GetConcurrencyConfig | GetConcurrencyConfig | Retrieves the concurrency configuration. |
| ListConcurrencyConfigs | ListConcurrencyConfigs | Lists the concurrency configurations. |
| PutConcurrencyConfig | PutConcurrencyConfig | Sets the concurrency for a function. |
Layer
|
API |
Title |
Description |
| CreateLayerVersion | CreateLayerVersion | This operation publishes a layer version. |
| DeleteLayerVersion | DeleteLayerVersion | Deletes a layer version. |
| GetLayerVersion | GetLayerVersion | Retrieves information about a layer version. |
| GetLayerVersionByArn | GetLayerVersionByArn | Retrieves the version information of a layer by its Alibaba Cloud Resource Name (ARN). |
| ListLayerVersions | ListLayerVersions | Retrieves a list of layer versions. |
| ListLayers | ListLayers | Lists layers. |
| PutLayerACL | PutLayerACL | Modifies the permissions of a layer. |
Instance
|
API |
Title |
Description |
| ListInstances | ListInstances | Lists function instances. |
VPC bindng
|
API |
Title |
Description |
| ListVpcBindings | ListVpcBindings | Queries existing VPC attachments. |
| CreateVpcBinding | CreateVpcBinding | Creates a VPC connection. |
| DeleteVpcBinding | DeleteVpcBinding | Deletes an access control policy from a specified VPC firewall policy group. |
Tag
|
API |
Title |
Description |
| TagResources | TagResources | Adds tags to specified resources. |
| ListTagResources | ListTagResources | Lists all tagged resources. |
| UntagResources | UntagResources | Removes tags from resources. |
Asynchronous task
|
API |
Title |
Description |
| GetAsyncTask | GetAsyncTask | Retrieves the details of a specified asynchronous task. |
| ListAsyncTasks | ListAsyncTasks | Lists the details of asynchronous tasks. |
| StopAsyncTask | StopAsyncTask | Stops an asynchronous task. |
Session
|
API |
Title |
Description |
| CreateSession | Create a session resource | Creates an explicit session resource. The system automatically generates a unique SessionID, pre-allocates a function instance, and binds it to the session. You can specify TTL and IdleTimeout. This operation applies to the HEADER_FIELD or GENERATED_COOKIE affinity types to implement session warm-up and configuration initialization. After the call, you can include the session in InvokeFunction requests for request routing. |
| ResumeSession | Resume a session | Resumes a session. |
| PauseSession | Pause a session | Pauses and saves a session. |
| GetSession | Get session configuration information | Retrieves the details of a specified session, including the session ID, associated function, affinity type, lifecycle configuration, status, and instance information. This operation queries the current metadata of a single session, supports precise identification by functionName and qualifier for external system monitoring and debugging, and only supports querying sessions in the Active state. |
| UpdateSession | Update session configuration | Updates the configuration of a session in Active state, such as lifecycle settings including SessionTTLInSeconds and SessionIdleTimeoutInSeconds. The update takes effect immediately, and LastModifiedTime is automatically refreshed. You can use this operation to extend or shorten the session validity period for dynamic management without changing the execution environment bound to the session. |
| ListSessions | Query session information list | Lists sessions in Active or Expired status under a specified function. Supports filtering by qualifier, status, and session ID, and supports paging. Returns basic session properties for batch viewing of session distribution and status, facilitating Service Monitoring and external system integration, and improving session visibility and management capabilities. |
| DeleteSession | Delete a session resource | Deletes a specified session, blocks new request routing, and purges session metadata from the database. Subsequent requests from the client carrying the same SessionID are treated as a new session. This operation releases resources and cleans up the session. In session isolation scenarios, the system stops running requests and releases instances bound to the session. In non-session isolation scenarios, running requests continue to run and terminate gracefully. |
Others
|
API |
Title |
Description |
| PutScalingConfig | PutScalingConfig | Set the elastic scaling configuration for a function. |
| DeleteScalingConfig | DeleteScalingConfig | Deletes the scaling settings of a function. |
| GetScalingConfig | GetScalingConfig | Retrieves the scaling configuration for a function. |
| ListScalingConfigs | ListScalingConfigs | Lists the auto scaling configurations for a function. |