This product(
FC/2023-03-30) OpenAPI adopts ROA Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Resource Group
| API | Title | Description |
|---|---|---|
| ChangeResourceGroup | ChangeResourceGroup | Updates 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 | Queries information about a custom domain name. |
| ListCustomDomains | ListCustomDomains | Queries custom domain names. |
| UpdateCustomDomain | UpdateCustomDomain | Update a custom domain name. |
Function
| API | Title | Description |
|---|---|---|
| DeleteFunctionVersion | DeleteFunctionVersion | Deletes a function version. |
| GetFunctionCode | GetFunctionCode | Queries a code package of a function. |
| ListFunctionVersions | ListFunctionVersions | Queries versions of a function. |
| PublishFunctionVersion | PublishFunctionVersion | Publishes a function version. |
| CreateFunction | CreateFunction | Creates a function. |
| DeleteFunction | DeleteFunction | Deletes a function. |
| GetFunction | GetFunction | http://pre.hhht/#vpc |
| ListFunctions | ListFunctions | Queries a list of functions. |
| InvokeFunction | InvokeFunction | Invokes a function. |
| UpdateFunction | UpdateFunction | Updates the information about a function. |
| 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 | The DisableFunctionInvocation operation prevents a function from being invoked and optionally terminates all requests that are being processed. Once a function's invocation is disabled, no new instances can be created, and the existing provisioned instances are destroyed. This operation is currently in private preview. |
Alias
| API | Title | Description |
|---|---|---|
| DeleteAlias | DeleteAlias | Deletes an alias. |
| GetAlias | GetAlias | Queries information about an alias. |
| ListAliases | ListAliases | Queries aliases. |
| UpdateAlias | UpdateAlias | Updates an alias. |
| CreateAlias | CreateAlias | Creates an alias. |
Trigger
| API | Title | Description |
|---|---|---|
| CreateTrigger | CreateTrigger | Creates a trigger. |
| DeleteTrigger | DeleteTrigger | Deletes a trigger. |
| GetTrigger | GetTrigger | Queries information about a trigger. |
| ListTriggers | ListTriggers | Queries the triggers of a function. |
| UpdateTrigger | UpdateTrigger | Modifies a trigger. |
FunctionAsyncInvokeConfig
| API | Title | Description |
|---|---|---|
| DeleteAsyncInvokeConfig | DeleteAsyncInvokeConfig | Deletes an asynchronous invocation configuration. |
| GetAsyncInvokeConfig | GetAsyncInvokeConfig | Gets asynchronous invocation configurations of a function. |
| ListAsyncInvokeConfigs | ListAsyncInvokeConfigs | Queries all asynchronous configurations of a function. |
| PutAsyncInvokeConfig | PutAsyncInvokeConfig | Creates or modifies an asynchronous invocation configuration for a function. |
FunctionProvisionConfig
| API | Title | Description |
|---|---|---|
| DeleteProvisionConfig | DeleteProvisionConfig | Deletes a provisioned configuration. |
| GetProvisionConfig | GetProvisionConfig | Queries provisioned configurations. |
| ListProvisionConfigs | ListProvisionConfigs | Queries a list of provisioned configurations. |
| PutProvisionConfig | PutProvisionConfig | Creates provisioned configurations. |
FunctionConcurrencyConfig
| API | Title | Description |
|---|---|---|
| DeleteConcurrencyConfig | DeleteConcurrencyConfig | Deletes a concurrency configuration. |
| GetConcurrencyConfig | GetConcurrencyConfig | Obtains a concurrency configuration. |
| ListConcurrencyConfigs | ListConcurrencyConfigs | Queries a list of concurrency configurations. |
| PutConcurrencyConfig | PutConcurrencyConfig | Configures concurrency of a function. |
Layer
| API | Title | Description |
|---|---|---|
| CreateLayerVersion | CreateLayerVersion | Releases a layer version. |
| DeleteLayerVersion | DeleteLayerVersion | Deletes a layer version. |
| GetLayerVersion | GetLayerVersion | Queries versions of a layer. |
| GetLayerVersionByArn | GetLayerVersionByArn | Obtain version information of a layer by using ARNs. |
| ListLayerVersions | ListLayerVersions | Gets a list of layer versions. |
| ListLayers | ListLayers | Gets a list of layers. |
| PutLayerACL | PutLayerACL | Modifies permissions of a layer. |
Instances
| API | Title | Description |
|---|---|---|
| ListInstances | ListInstances | Queries a list of function instances. |
VpcBinding
| API | Title | Description |
|---|---|---|
| ListVpcBindings | ListVpcBindings | Queries a list of existing VPC connections. |
| CreateVpcBinding | CreateVpcBinding | Creates a VPC connection. |
| DeleteVpcBinding | DeleteVpcBinding | Deletes an access control policy from a specified policy group for a VPC firewall. |
Tag
| API | Title | Description |
|---|---|---|
| TagResources | TagResources | Adds tags to a resource. |
| ListTagResources | ListTagResources | Lists all tagged resources. |
| UntagResources | UntagResources | Removes tags from a resource. |
asynchronous task
| API | Title | Description |
|---|---|---|
| GetAsyncTask | GetAsyncTask | Queries the information about an asynchronous task. |
| ListAsyncTasks | ListAsyncTasks | Lists asynchronous tasks. |
| StopAsyncTask | StopAsyncTask | Stops an asynchronous task. |
Session
| API | Title | Description |
|---|---|---|
| CreateSession | CreateSession | The CreateSession operation creates an explicit session resource. The system automatically generates a unique session ID, pre-allocates a function instance, and associates it with the session. You can specify values for TTL and idle timeout. This method applies to the HEADER_FIELD and GENERATED_COOKIE affinity types. It handles session preload and configuration initialization. After you call the InvokeFunction API, the session information can be included in the InvokeFunction request to enable 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. |
Others
| API | Title | Description |
|---|---|---|
| PutScalingConfig | PutScalingConfig | Scaling settings |
| DeleteScalingConfig | DeleteScalingConfig | Deletes the scaling settings of a function. |
| GetScalingConfig | GetScalingConfig | Gets the scaling settings of a function. |
| ListScalingConfigs | ListScalingConfigs | Lists the scaling settings of a function. |