Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Multi-tenancy/ Enabling or Disabling Multi-tenancy
Updated on 2025-09-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling or Disabling Multi-tenancy

Function

This API is used to enable or disable multi-tenancy. Before calling this API:

URI

PUT /v3/{project_id}/instances/{instance_id}/multi-tenant

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

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

multi_tenant_switch

Yes

Boolean

Definition

Whether to enable multi-tenancy for an instance.

Constraints

N/A

Range

  • true: Multi-tenancy is enabled.

  • false: Multi-tenancy is disabled.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Definition

ID of the task for enabling or disabling multi-tenancy.

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

  • Enabling multi-tenancy 
    PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/multi-tenant

{
  "multi_tenant_switch" : true
}
  • Disabling multi-tenancy 
    PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/multi-tenant

{
  "multi_tenant_switch" : false
}

Example Response

Status code: 200

Success.

{
  "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Multi-tenancy