文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 用户信息管理/ 获取租户冻结状态信息
更新时间：2025-07-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取租户冻结状态信息

功能介绍

获取租户冻结状态信息

调用方法

请参见如何调用API。

URI

GET /v4/domain/frozen/info

表1 Query参数

参数

是否必选

参数类型

描述

project_uuid

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueDomainFreezeStatus object

获取租户冻结状态信息返回参数

error

ApiError object

错误信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址
表3 ResultValueDomainFreezeStatus

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

DomainFreezeStatus object

返回的数据

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表4 DomainFreezeStatus

参数

参数类型

描述

freeze_status

Integer

租户冻结状态

freeze_type

Array of FreezeInfoVo objects

租户冻结的类型

is_current_domain

Integer

是否为跨租户场景
表5 FreezeInfoVo

参数

参数类型

描述

type

Integer

租户冻结类型

priority

Integer

租户冻结类型优先级
表6 ApiError

参数

参数类型

描述

code

String

参数解释

错误编码

取值范围

不涉及

reason

String

参数解释

业务失败的提示内容

取值范围

不涉及

请求示例

get https://{endpoint}/v4/domain/frozen/info?project_uuid=75681cbb7c324e15a9eb8ee74a96a474

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "freeze_status" : "1"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 用户信息管理

相关文档