Setting a Serverless Compute Policy

Function

This API is used to set a serverless compute policy. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

PUT /v3.1/{project_id}/instances/{instance_id}/serverless/policy

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
min_vcpus	Yes	Integer	Definition Minimum number of vCPUs for a single node. Constraints N/A Range The value range can be obtained by calling the Querying Database Specifications API. Default Value N/A
max_vcpus	Yes	Integer	Definition Maximum number of vCPUs for a single node. Constraints N/A Range ≥ 4. The value range can be obtained by calling the Querying Database Specifications API. Default Value N/A
need_update_nodes_compute_ability	No	Boolean	Definition Whether to synchronize the current compute of nodes below the minimum compute to the minimum compute when you change the compute range. Constraints N/A Range true: The node compute is synchronized. false: The node compute is not synchronized. Default Value false
scale_out_switch	No	Boolean	Definition Whether to enable the function for adding or deleting read replicas. Constraints The function is only available when there is a proxy instance. When using the function, do not use the private IP address for read to connect to your application. Enabling the function switches the proxy instance's routing policy to load balancing. Range true: The function for adding or deleting read replicas is enabled. false: The function for adding or deleting read replicas is disabled. Default Value false
max_readonly_node_count	No	Integer	Definition Maximum number of read replicas. Constraints This parameter is only valid and mandatory when the function for adding or deleting read replicas is enabled. Range 2–7 Default Value N/A
min_readonly_node_count	No	Integer	Definition Minimum number of read replicas. Constraints This parameter is only valid and mandatory when the function for adding or deleting read replicas is enabled. Range 1–6 Default Value N/A

Response Parameters

Status code: 200

Success.

Status code: 400

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

Status code: 500

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

Example Request

Setting the minimum number of vCPUs to 0.5 and the maximum number of vCPUs to 4

PUT https://{endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/serverless/policy

{
  "min_vcpus" : 0.5,
  "max_vcpus" : 4
}