Help Center/ MetaStudio/ API Reference/ Tenant Management/ Configuring Tenant Services
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Configuring Tenant Services

Function

Configures tenant services.

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. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v1/{project_id}/tenants/service-configs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

The format is YYYYMMDD'T'HHMMSS'Z'.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

sub_account_control_config

No

SubAccountControlConfig object

IAM user control configuration

is_ai_mark_on

No

Boolean

AI identifier switch

Default value:

false
Table 4 SubAccountControlConfig

Parameter

Mandatory

Type

Description

separately_controlled

No

Boolean

Whether the IAM user service is controlled separately.

Default value:

false

sub_account_type

No

String

IAM user type.

  • IAM_USER: IAM user id of the caller is used to replace X-App-UserId. If a request contains X-App-UserId, X-App-UserId will be replaced.

Response Parameters

Status code: 200

Table 5 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 6 Response body parameters

Parameter

Type

Description

service_shared_config

ServiceSharedConfig object

Service sharing configuration

tenant_log_config

TenantLogConfig object

Tenant log configuration

sub_account_control_config

SubAccountControlConfig object

IAM user control configuration

is_ai_mark_on

Boolean

AI identifier switch.

tenant_id

String

Tenant project ID
Table 7 ServiceSharedConfig

Parameter

Type

Description

enable

Boolean

Enables sharing configuration.

Default value:

true

optional_project_ids

Array of strings

Tenants entitled for sharing

no_need_review

Boolean

Sharing without review

Default value:

false
Table 8 TenantLogConfig

Parameter

Type

Description

log_group_id

String

Log group ID.

log_stream_id

String

Log stream ID.
Table 9 SubAccountControlConfig

Parameter

Type

Description

separately_controlled

Boolean

Whether the IAM user service is controlled separately.

Default value:

false

sub_account_type

String

IAM user type.

  • IAM_USER: IAM user id of the caller is used to replace X-App-UserId. If a request contains X-App-UserId, X-App-UserId will be replaced.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

put https://{endpoint}/v1/{project_id}/tenants/service-configs

{
  "sub_account_control_config" : {
    "separately_controlled" : true,
    "sub_account_type" : "IAM_USER"
  }
}

Example Responses

Status code: 200

Tenant services are successfully configured.

{
  "tenant_id" : "e87104f76d7546ce8a46ac6b04c49c3c",
  "default_watermark_config" : {
    "text" : "Some content is generated by AI."
  }
}

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

Tenant services are successfully configured.

400

Parameters error, including the error code and its description.

Error Codes

See Error Codes.

Parent Topic: Tenant Management