Configuring a Dynamic Serverless Compute Policy

Function

This API is used to configure a dynamic serverless compute policy for an instance. Before calling this API:

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

Constraints

This API is in the OBT phase. To use it, submit a service ticket.

Prerequisites for enabling dynamic serverless:

This function is only available for multi-AZ dedicated x86 instances with fixed specifications (pay-per-use or yearly/monthly).
This function is only available for cluster instances. It is not available for single-node, multi-primary, or serverless instances.
This function is only available for instances with a CPU-to-memory ratio of 1:4, where read replicas must have identical specifications to the primary node.
This function is only available for instances with a kernel version of 2.0.54.240600 or later and auto scaling disabled.

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.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
gaussdbformysql:serverless:updateDynamicPolicy	Write	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:serverless:updateDynamicPolicy	-

URI

POST /v3/{project_id}/instances/{instance_id}/serverless/dynamic-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. To obtain this value, see Querying DB Instances. 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	String	Definition Minimum dynamic serverless compute. Constraints N/A Range The value range can be obtained from Querying a Dynamic Serverless Compute Policy. The value must be less than or equal to that of max_vcpus. Default Value N/A
max_vcpus	Yes	String	Definition Maximum dynamic serverless compute. Constraints N/A Range The value range can be obtained from Querying a Dynamic Serverless Compute Policy. The value must be greater than or equal to that of min_vcpus. 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

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
job_id	String	Definition ID of the task for configuring dynamic serverless. Range N/A

Status code: 400

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

Status code: 500

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

Example Request

Configuring a dynamic serverless compute policy for an instance

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/serverless/dynamic-policy

{
  "min_vcpus" : 2,
  "max_vcpus" : 32,
  "need_update_nodes_compute_ability" : true
}

Example Response

Status code: 200

Success.

Configuring a dynamic serverless compute policy for an instance with dynamic serverless disabled
```
{
  "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
}
```
Configuring a dynamic serverless compute policy for an instance with dynamic serverless enabled
```
{
  "job_id" : null
}
```