Help Center/ FunctionGraph/ API Reference/ APIs/ Function Lifecycle Management/ Updating Max. Instances of a Function

Updated on 2026-10-27 GMT+08:00

Updating Max. Instances of a Function

Function

This API is used to update the maximum number of instances of a function.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v2/{project_id}/fgs/functions/{function_urn}/config-max-instance

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: None Value range: 32 characters, including letters and digits. Default value: None
function_urn	Yes	String	Parameter description: URN of the function. For details, see Function Model. Constraints: None Value range: Only letters, digits, underscores (_), hyphens (-), and colons (:) are allowed. Default value: None

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Parameter description: User token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints: None Value range: None Default value: None
Content-Type	Yes	String	Parameter description: Specifies the type (or format) of the message body. Constraints: None Value range: Only application/json is supported. Default value: application/json

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
max_instance_num	No	Integer	Maximum number of instances. -1 indicates that the number of instances is unlimited, and 0 indicates that the function is disabled.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
func_urn	String	Function URN.
func_name	String	Function name.
domain_id	String	Domain ID.
namespace	String	Project ID.
project_name	String	Project name.
package	String	Group to which the function belongs. This field is defined to group functions.
runtime	String	Parameter description: FunctionGraph runtime, that is, the function execution environment. Range Java8: Java 8 Java11: Java 11 Java17: Java 17 Java21: Java 21 Python2.7: Python 2.7 Python3.6: Python 3.6 Python3.9: Python 3.9 Python3.10: Python 3.10 Python3.12: Python 3.12 Go1.x: Go 1.x Node.js6.10: Nodejs 6.10 Node.js8.10: Nodejs 8.10 Node.js10.16: Nodejs 10.16 Node.js12.13: Nodejs 12.13 Node.js14.18: Nodejs 14.18 Node.js16.17: Nodejs 16.17 Node.js18.15: Nodejs 18.15 Node.js20.15: Nodejs 20.15 C#(.NET Core 2.1): C# 2.1 C#(.NET Core 3.1): C# 3.1 C#(.NET Core 6.0): C# 6.0 C#(.NET Core 8.0): C# 8.0 Custom: custom runtime PHP7.3: Php 7.3 PHP8.3: Php 8.3 Cangjie1.0 Cangjie0.52.3 HTTP Custom image-based functions
timeout	Integer	Maximum duration the function can be executed. Value range: 3s–259,200s.
handler	String	Handler It is in the format of "xx.xx" and must contain a period (.). ; the handler of the custom image function is "-." For example, for Node.js function myfunction.handler, the file name is myfunction.js, and the handler function is handler. Can contain a maximum of 128 characters.
memory_size	Integer	Parameter description: Memory (MB) consumed by the function. Range 128 256 512 768 1024 1280 1536 1792 2048 2560 3072 3584 4096
cpu	Integer	CPU resources of a function. Unit: millicore (1 core = 1000 millicores). The value of this field is proportional to that of MemorySize. By default, 100 CPU millicores are required for 128 MB memory.
code_type	String	Function code type. Options: inline: inline code zip: ZIP file obs: function code stored in an OBS bucket jar: JAR file, mainly for Java functions Custom-Image-Swr: The function code comes from the SWR custom image.
code_url	String	If CodeType is set to obs, enter the OBS URL of the function code package. If CodeType is not set to obs, leave this parameter blank.
code_filename	String	Name of a function file. This parameter is mandatory only when CodeType is set to jar or zip.
code_size	Long	Code size in bytes.
user_data	String	Name/Value information defined for the function. These are parameters used in the function. For example, if the function needs to access a host, you can set a custom parameter Host={host_ip}. The total length cannot exceed 4 KB.
encrypted_user_data	String	User-defined name/value to be encrypted.
digest	String	SHA512 hash value of function code, which is used to determine whether the function has changed.
version	String	Function version, which is automatically generated by the system. The version name is in the format of "vYYYYMMDD-HHMMSS" (v+year/month/day-hour/minute/second).
image_name	String	Internal identifier of a function version.
xrole	String	Agency used by the function. You need to create an agency on the IAM console. This field is mandatory when a function needs to access other services. After specifying a function execution agency, you can use the context method in the function handler to obtain a token, an AK, and an SK for accessing other cloud services. No agency is required if FunctionGraph does not access any cloud services.
app_xrole	String	Execution agency. You can optimize performance by configuring a separate agency for function execution, otherwise, the same agency is used for both execution and configuration.
description	String	Function description.
last_modified	String	Time when the function was last updated.
func_vpc	FuncVpc object	VPC configuration. An agency with VPC permissions must be configured for the function.
mount_config	MountConfig object	Mounting configuration.
status	Integer	Function status. The options are as follows: 0: enabled 1: disabled
strategy_config	StrategyConfig object	Parameter description: Function policy configuration.
dependencies	Array of Dependency objects	Dependency packages.
initializer_handler	String	Initializer of the function in the format of "xx.xx". It must contain a period (.). This parameter is mandatory when the initialization function is configured. For example, for Node.js function myfunction.initializer, the file name is myfunction.js, and the initialization function is initializer.
initializer_timeout	Integer	Maximum duration the function can be initialized. Value range: 1s–300s. This parameter is mandatory when the initialization function is configured.
pre_stop_handler	String	The pre-stop handler of a function. The value must contain a period (.) in the format of xx.xx. For example, for Node.js function myfunction.pre_stop_handler, the file name is myfunction.js, and the initialization function is pre_stop_handler.
pre_stop_timeout	Integer	Maximum duration the function can be initialized. Value range: 1s–90s.
enterprise_project_id	String	Enterprise project ID. This parameter is mandatory if you create a function as an enterprise user.
long_time	Boolean	Whether to allow a long timeout.
log_group_id	String	Log group ID.
log_stream_id	String	Log stream ID.
type	String	Definition Function type. Range v1: discarded version v2: official version
enable_cloud_debug	String	enable_cloud_debug: Whether to enable cloud debugging to adapt to the CloudDebug scenario. (discarded)
enable_dynamic_memory	Boolean	Whether to enable dynamic memory allocation.
is_stateful_function	Boolean	Whether stateful functions are supported. This parameter is supported in FunctionGraph v2.
domain_names	String	Private domain name configured for resolution.
is_return_stream	Boolean	Whether to return stream data (discarded)
enable_auth_in_header	Boolean	Whether to allow authentication information to be added to the request header. This parameter applies only to custom image functions.

**Table 5** FuncVpc
Parameter	Type	Description
domain_id	String	Parameter description: Tenant account ID. Value range: None
namespace	String	Parameter description: Project ID. Value range: None
vpc_name	String	Definition: VPC name Value range: None
vpc_id	String	Parameter description: VPC ID. Value range: None
subnet_name	String	Parameter description: Subnet name. Value range: None
subnet_id	String	Parameter description: Subnet ID. Value range: None
cidr	String	Parameter description: Subnet mask. Value range: None
gateway	String	Parameter description: Gateway. Value range: None
security_groups	Array of strings	Parameter description: Security Group Value range: Character string list
is_safety	Boolean	Definition Whether to enable secure access. When secure access is enabled, you need to configure the VPCEP network to establish a secure VPC connection to private domain names. Once enabled, this feature cannot be disabled. Range true: Yes false: No

**Table 6** MountConfig
Parameter	Type	Description
mount_user	MountUser object	User information.
func_mounts	Array of FuncMount objects	Parameter description: Mounted resources. Value range: None

**Table 7** MountUser
Parameter	Type	Description
user_id	Integer	Parameter description: User ID. Value range: An integer ranging from -1 to 65534
user_group_id	Integer	Parameter description: Group ID Value range: An integer ranging from -1 to 65534

**Table 8** FuncMount
Parameter	Type	Description
mount_type	String	Definition Mount type. This parameter is mandatory when func_mounts is not empty. Range sfs: SFS Capacity-Oriented sfsTurbo: SFS ecs: ECS
mount_resource	String	Parameter description: ID of the mounted resource (cloud service ID). This parameter is mandatory when func_mounts is not empty. Value range: None
mount_share_path	String	Parameter description: Remote mount path. For example, 192.168.0.12:/data. This parameter is mandatory if mount_type is set to ecs. Value range: Shared path opened by the ECS
local_mount_path	String	Parameter description: Function access path. This parameter is mandatory when func_mounts is not empty. Value range: Mount directory in the function container. The directory is generally a two-layer structure.

**Table 9** StrategyConfig
Parameter	Type	Description
concurrency	Integer	Parameter description: Specifies the maximum number of instances for a function. The value -1 indicates that the number of instances is not limited. Value range: v1: 0 and -1 v2: [–1, 1000]
concurrent_num	Integer	Parameter description: Specifies the number of concurrent requests per instance. This parameter is supported in v2. Value range: [1, 1000]

**Table 10** Dependency
Parameter	Type	Description
id	String	Parameter description: Dependency version ID. Value range: None
owner	String	Parameter description: Domain ID of the dependency owner. Value range: None
link	String	Parameter description: URL of the dependency on OBS. Value range: OBS link
runtime	String	Parameter description: Runtime of a function. Value range: Java8: Java 8 Java11: Java 11 Java17: Java 17 Java21: Java 21 Python2.7: Python 2.7 Python3.6: Python 3.6 Python3.9: Python 3.9 Python3.10: Python 3.10 Python3.12: Python 3.12 Go1.x: Go 1.x Node.js6.10: Nodejs 6.10 Node.js8.10: Nodejs 8.10 Node.js10.16: Nodejs 10.16 Node.js12.13: Nodejs 12.13 Node.js14.18: Nodejs 14.18 Node.js16.17: Nodejs 16.17 Node.js18.15: Nodejs 18.15 Node.js20.15: Nodejs 20.15 C#(.NET Core 2.1): C# 2.1 C#(.NET Core 3.1): C# 3.1 C#(.NET Core 6.0): C# 6.0 C#(.NET Core 8.0): C# 8.0 Custom PHP7.3: Php 7.3 PHP8.3: Php 8.3 Cangjie1.0 Cangjie0.52.3 HTTP Custom image-based functions
etag	String	Parameter description: MD5 value of a dependency. Value range: None
size	Long	Parameter description: Dependency size. Value range: None
name	String	Parameter description: Name of a dependency package. Value range: None
description	String	Parameter description: Dependency description. Value range: None
file_name	String	Parameter description: File name of a dependency package (ZIP). Value range: None
version	Long	Parameter description: Dependency version ID. Value range: None
dep_id	String	Parameter description: Dependency ID. Value range: None
last_modified	String	Parameter description: Time when the function was last updated. Value range: None

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Update the maximum number of instances of a function to 300.

PUT https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn}/config-max-instance

{
  "max_instance_num" : 300
}

Example Responses

Status code: 200

{
  "func_urn" : "urn:fss:xxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test",
  "func_name" : "test",
  "domain_id" : "14ee2e3501124efcbca7998baa24xxxx",
  "namespace" : "46b6f338fc3445b8846c71dfb1fbxxxx",
  "project_name" : "xxxxxx",
  "package" : "default",
  "runtime" : "Node.js6.10",
  "timeout" : 3,
  "handler" : "fssExampleCsharp2.1::fssExampleCsharp21.Program::MyFunc",
  "memory_size" : 128,
  "cpu" : 1024,
  "code_type" : "inline",
  "code_filename" : "index.js",
  "code_size" : 272,
  "digest" : "faa825575c45437cddd4e369bea69893bcbe195d478178462ad90984fe72993f3f59d15f41c5373f807f3e05fb9af322c55dabeb16565c386e402413458e6068",
  "version" : "latest",
  "image_name" : "latest-191025153727@zehht",
  "last_modified" : "2019-10-25 15:37:27",
  "status" : 0,
  "strategy_config" : {
    "concurrency" : 300,
    "concurrent_num" : 1
  }
}

SDK Sample Code

The SDK sample code is as follows.

Java

Update the maximum number of instances of a function to 300.

     package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.functiongraph.v2.region.FunctionGraphRegion;
import com.huaweicloud.sdk.functiongraph.v2.*;
import com.huaweicloud.sdk.functiongraph.v2.model.*;


public class UpdateFunctionMaxInstanceConfigSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        FunctionGraphClient client = FunctionGraphClient.newBuilder()
                .withCredential(auth)
                .withRegion(FunctionGraphRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateFunctionMaxInstanceConfigRequest request = new UpdateFunctionMaxInstanceConfigRequest();
        request.withFunctionUrn("{function_urn}");
        UpdateFunctionMaxInstanceConfigRequestBody body = new UpdateFunctionMaxInstanceConfigRequestBody();
        body.withMaxInstanceNum(300);
        request.withBody(body);
        try {
            UpdateFunctionMaxInstanceConfigResponse response = client.updateFunctionMaxInstanceConfig(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 
 
  

Python

Update the maximum number of instances of a function to 300.

     # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkfunctiongraph.v2.region.functiongraph_region import FunctionGraphRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkfunctiongraph.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = FunctionGraphClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(FunctionGraphRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateFunctionMaxInstanceConfigRequest()
        request.function_urn = "{function_urn}"
        request.body = UpdateFunctionMaxInstanceConfigRequestBody(
            max_instance_num=300
        )
        response = client.update_function_max_instance_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 
 
  

Go

Update the maximum number of instances of a function to 300.

     package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    functiongraph "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := functiongraph.FunctionGraphClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := functiongraph.NewFunctionGraphClient(hcClient)

    request := &model.UpdateFunctionMaxInstanceConfigRequest{}
	request.FunctionUrn = "{function_urn}"
	maxInstanceNumUpdateFunctionMaxInstanceConfigRequestBody:= int32(300)
	request.Body = &model.UpdateFunctionMaxInstanceConfigRequestBody{
		MaxInstanceNum: &maxInstanceNumUpdateFunctionMaxInstanceConfigRequestBody,
	}
	response, err := client.UpdateFunctionMaxInstanceConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
 
 
  

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code	Description
200	OK
400	Bad request.
401	Unauthorized.
403	Forbidden.
404	Not found.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: Function Lifecycle Management

Previous topic: Querying the Metadata of a Function

Next topic: Modifying the Metadata of a Function

Updating Max. Instances of a Function

Function

Calling Method

Authorization Information

URI

Request Parameters

Response Parameters

Example Requests

Example Responses

SDK Sample Code

Java

Python

Go

More

Status Codes

Error Codes

What is your overall rating for this page?