Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Querying a Serverless Compute Policy
Updated on 2025-10-11 GMT+08:00

Querying a Serverless Compute Policy

Function

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

URI

GET /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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

current_vcpus

String

Definition

Current compute.

Range

The value is between the maximum compute and the minimum compute.

min_vcpus

String

Definition

Minimum compute.

Range

≥ 0.5

max_vcpus

String

Definition

Maximum compute.

Range

≥ 4

scale_out_switch

Boolean

Definition

Whether read replicas can be automatically added or deleted.

Range

  • true: Read replicas can be automatically added or deleted.

  • false: Read replicas cannot be automatically added or deleted.

max_readonly_node_count

Integer

Definition

Maximum number of read replicas.

Range

≥ 2

min_readonly_node_count

Integer

Definition

Minimum number of read replicas.

Range

≥ 1

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

Querying a serverless compute policy

GET https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/c70a7eed50b14ee4969449ab5166aa7bin07/serverless/policy

Example Response

Status code: 200

Success.

{
  "current_vcpus" : 2,
  "min_vcpus" : 2,
  "max_vcpus" : 6,
  "scale_out_switch" : false,
  "max_readonly_node_count" : null,
  "min_readonly_node_count" : null
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.