Updated on 2026-05-21 GMT+08:00

Activating and Initializing a Tenant Service

Function

Activates a tenant service.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:tenants:active

    Write

    -

    -

    -

    -

URI

POST /v1/{project_id}/tenant/action/active

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

service_status

Yes

String

Service status.

  • active: activated

  • inactive: inactive

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

project_id

String

Tenant ID (tenant_id).

service_status

String

Indicates whether an enterprise is activated. The options are active and inactive.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

{
  "service_status" : "active"
}

Example Responses

Status code: 200

Response to a successful request.

{
  "project_id" : "165454xx5845",
  "service_status" : "active"
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

503

Service unavailable.

Error Codes

See Error Codes.