API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (FC/2023-03-30) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
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. |
CustomDomain
|
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 | CreateFunction | You can call the CreateFunction operation to create a function. |
| DeleteFunction | DeleteFunction | Deletes a function. |
| GetFunction | GetFunction | Retrieves information about a function. |
| ListFunctions | ListFunctions | Lists functions. |
| InvokeFunction | InvokeFunction | Invokes a function. |
| UpdateFunction | UpdateFunction | Updates a function's 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. |
FunctionAsyncInvokeConfig
|
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. |
FunctionProvisionConfig
|
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. |
FunctionConcurrencyConfig
|
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. |
Instances
|
API |
Title |
Description |
| ListInstances | ListInstances | Lists function instances. |
VpcBinding
|
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 | CreateSession | Creates an explicit session resource by automatically generating a unique session ID, pre-allocating a function instance, and attaching the session. This operation supports custom Time to Live (TTL) and idle timeout values, applies to HEADER_FIELD or GENERATED_COOKIE affinity types, and is used for session prefetching and configuration initialization. After the session is created, include the session ID in InvokeFunction requests for request routing. |
| GetSession | GetSession | You can use this operation to retrieve detailed information about a specific session, including its session ID, associated function, affinity type, lifecycle configuration, status, and instance details. This operation retrieves the current metadata for a session. You can identify the metadata precisely using either the function name or qualifier. This capability enables you to monitor and debug external systems with ease. Only sessions that are in the Active state can be queried. |
| UpdateSession | UpdateSession | Updates session configurations while the session is in the Active state, such as lifecycle parameters (e.g., SessionTTLInSeconds and SessionIdleTimeoutInSeconds). After the update takes effect, LastModifiedTime is automatically refreshed. These updates can be used to extend or shorten the validity period of a session and enable dynamic management without changing the execution environment bound to the session. |
| ListSessions | ListSessions | Lists sessions in the Active and/or Expired state(s) under the specified function. Supports filtering by qualifier, status, and session ID, as well as paginated queries. Returns basic session attributes for batch viewing of session distribution and status, helping with operations monitoring and integration with external systems, and enhancing session visibility and management. |
| DeleteSession | DeleteSession | Deletes the specified session and prohibits new requests from being routed to it. Clears the session metadata from the database, so subsequent requests with the same session ID are treated as new sessions. Releases resources and performs session cleanup. In session isolation scenarios, terminates running requests and releases the instance bound to the session. In non-session isolation scenarios, allows running requests to continue and gracefully terminates them. |
Other
|
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. |
Others
|
API |
Title |
Description |
| PauseSession | PauseSession | Pauses and saves a session. |
| ResumeSession | ResumeSession | Resume a session |