Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Setting a Policy for a Serverless DB Instance
Updated on 2024-09-11 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

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

To obtain the value, call the API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Content-Type

Yes

String

Content type.

Value: application/json

X-Language

No

String

Language.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

min_vcpus

Yes

Integer

Minimum number of vCPUs on a single node. The value range can be obtained by calling the Querying Database Specifications API.

max_vcpus

Yes

Integer

Maximum number of vCPUs on a single node. The value range can be obtained by calling the Querying Database Specifications API.

Response Parameters

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

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.