Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Setting a Policy for a Serverless DB Instance
Updated on 2025-09-04 GMT+08:00

Setting a Policy for a Serverless DB Instance

Function

This API is used to set a policy for a serverless DB instance. Before calling this API:

URI

PUT /v3/{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.

Range

You can obtain the value of this parameter from Querying Database Specifications.

max_vcpus

Yes

Integer

Definition

Maximum number of vCPUs for a single node.

Range

You can obtain the value of this parameter from Querying Database Specifications.

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 1 and the maximum number of vCPUs to 4

PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/serverless/policy

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

Example Response

None

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.