DisableFunctionInvocation - Function Compute - Alibaba Cloud Documentation Center

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.

Operation description

Use caution when calling this API for functions in a production environment because disabling function invocations can disrupt your services.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fc:DisableFunctionInvocation

update

*Function

acs:fc:{#regionId}:{#accountId}:functions/{#FunctionName}

None

Request syntax

POST /2023-03-30/functions/{functionName}/invoke/disable HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
functionName	string	No	The name of the function to disable.	helloworld

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters for disabling a function invocation
reason	string	No	The reason for disabling the function invocation.	业务下线
abortOngoingRequest	boolean	No	Specifies whether to immediately stop all ongoing requests.	false

Response elements

Element	Type	Description	Example
	object	The response for successfully disabling a function invocation.
success	boolean	Indicates whether the function invocation was successfully disabled.	true

Examples

Success response

JSON format

{
  "success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.