Updated on 2025-08-21 GMT+08:00

Querying Tenant Status

Function

This API is used to query tenant status.

Calling Method

For details, see Calling APIs.

URI

GET /v1/domain/status

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

result

result object

Definition

Tenant status information.

Range

N/A.

error

String

Definition

Returned error message.

Range

N/A.

status

String

Definition

Returned status information.

Range

success: The API call is successful.

fail: The API call failed.

Table 2 result

Parameter

Type

Description

status

Number

Tenant status. The options are as follows: 0: not enabled; 1: normal; 2: frozen; 3: disabled; 4 and 5: deregistered.

free_quota

Boolean

Whether the free quota is included.

allow_custom_env

Number

Whether to use a custom environment.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v1/domain/status

Example Responses

Status code: 200

OK

{
  "result" : {
    "status" : 1,
    "free_quota" : false,
    "allow_custom_env" : 0
  },
  "error" : null,
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.