Help Center/ FunctionGraph/ API Reference/ APIs/ Reserved Instances/ Changing the Number of Reserved Instances

Updated on 2024-03-26 GMT+08:00

Online Debugging

CLI Examples

View PDF

Changing the Number of Reserved Instances

Function

This API is used to change the number of reserved instances.

URI

PUT /v2/{project_id}/fgs/functions/{function_urn}/reservedinstances

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
function_urn	Yes	String	Function URN. For details, see the function model description.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	Message body type (format).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
count	Yes	Integer	Number of reserved instances.
idle_mode	No	Boolean	Whether to enable the idle mode.
tactics_config	No	TacticsConfig object

**Table 4** TacticsConfig
Parameter	Mandatory	Type	Description
cron_configs	No	Array of CronConfig objects	Scheduled configuration list.
metric_configs	No	Array of MetricConfig objects	Flow control configuration list.

**Table 5** CronConfig
Parameter	Mandatory	Type	Description
name	No	String	Scheduled configuration name.
cron	No	String	Cron expression.
count	No	Integer	Number of started reserved instances.
start_time	No	Long	Start time (epoch format).
expired_time	No	Long	Expiry time (epoch format).

**Table 6** MetricConfig
Parameter	Mandatory	Type	Description
name	No	String	Flow control configuration name.
type	No	String	Flow control type. Currently, only reserved instance utilization is supported. Enumeration values: Concurrency
threshold	No	Integer	Flow control threshold.
min	No	Integer	Minimum value.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
count	Integer	Number of reserved instances.
idle_mode	Boolean	Whether to enable idle mode.
tactics_config	TacticsConfig object

**Table 8** TacticsConfig
Parameter	Type	Description
cron_configs	Array of CronConfig objects	Scheduled configuration list.
metric_configs	Array of MetricConfig objects	Flow control configuration list.

**Table 9** CronConfig
Parameter	Type	Description
name	String	Scheduled configuration name.
cron	String	Cron expression.
count	Integer	Number of started reserved instances.
start_time	Long	Start time (epoch format).
expired_time	Long	Expiry time (epoch format).

**Table 10** MetricConfig
Parameter	Type	Description
name	String	Flow control configuration name.
type	String	Flow control type. Currently, only reserved instance utilization is supported. Enumeration values: Concurrency
threshold	Integer	Flow control threshold.
min	Integer	Minimum value.

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 number of a function's reserved instances to 3.

PUT https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn}/reservedinstances

{
  "count" : 3
}

Example Responses

Status code: 200

{
  "count" : 2
}

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: Reserved Instances

Previous topic: Querying Reserved Instances of a Function

Next topic: Querying the Number of Reserved Instances

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot