文档首页/ 编译构建 CodeArts Build/ API参考/ 编译构建API/ 租户管理/ 查询租户状态
更新时间：2025-08-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询租户状态

功能介绍

查询租户状态。

调用方法

请参见如何调用API。

URI

GET /v1/domain/status

请求参数

无

响应参数

状态码：200

表1 响应Body参数

参数

参数类型

描述

result

result object

参数解释：

租户状态信息。

取值范围：

不涉及。

error

String

参数解释：

返回错误信息。

取值范围：

不涉及。

status

String

参数解释：

返回状态信息。

取值范围：

● success：表示接口调用成功。

● fail：表示接口调用失败。
表2 result

参数

参数类型

描述

status

Number

租户状态0:未开通; 1:正常; 2:冻结; 3:关闭; 4、5:注销

free_quota

Boolean

是否包含免费额度

allow_custom_env

Number

是否启用自定义环境

状态码：400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

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

响应示例

状态码：200

OK

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 租户管理