查询租户信息

查询租户信息

更新时间：2026-04-10 12:01:00

编辑

本文介绍如何通过 API 查询指定租户的详细信息。

调用说明

如果设置了密码，则需要通过认证。详情可参见 API 混合加密。

请求路径

GET /api/v1/tenant/:name

返回结果

参数	类型	说明
successful	bool	请求是否成功。
timestamp	time.Time	服务端完成请求的时间戳。
duration	int	服务端处理请求的时间（毫秒）。
status	in	符合 HTTP Status 规范的编码。
traceId	string	请求的 Trace ID。
data	TenantInfo	指定租户的详细信息，详情参见 TenantInfo 的数据结构。
error	ApiError	请求产生的 Error，包含如下信息： `code`：错误码。 `message`：错误详细信息。 `subErrors`：子错误信息。

TenantInfo 的数据结构：

参数	类型	说明
name	string	租户的名称。
id	int	租户 ID。
created_time	time.Time	租户被创建的时间。
mode	string	租户模式。
status	string	租户状态。
locked	string	租户是否被锁定。
primary_zone	string	租户的 Primary Zone。
locality	string	租户的 Locality 信息。
in_recyclebin	string	租户是否位于回收站中。
charset	string	租户使用的字符集。
collation	string	租户使用的字符序。
whitelist	string	租户的访问白名单。
pool	[]ResourcePoolWithUnit	租户所使用的资源池信息，详情参见 ResourcePoolWithUnit 的数据结构。

ResourcePoolWithUnit 的数据结构：

参数	类型	说明
pool_name	string	资源池名称。
pool_id	int	资源池 ID。
zone_list	string	资源池位于的 Zone 列表。
unit_num	int	资源池的 unit 个数。
unit_config	ObUnitConfig	资源池所有使用的资源规格的信息，详情参见 ObUnitConfig 的数据结构。

ObUnitConfig 的数据结构：

参数	类型	说明
create_time	time.Time	资源规格的创建时间。
modify_time	time.Time	资源规格的修改时间。
unit_config_id	int	资源规格 ID。
name	string	资源规格的名称。
max_cpu	float64	CPU 规格的上限。
min_cpu	float64	CPU 规格的下限，
memory_size	int	内存规格。
log_disk_size	int	日志盘空间的大小。
max_iops	uint	IOPS 的上限。
min_iops	uint	IOPS 的下限。

示例

请求示例

GET 10.10.10.1:2886/api/v1/tenant/t1

返回示例

{
    "successful": true,
    "timestamp": "2024-10-14T14:27:47.6484216+08:00",
    "duration": 69,
    "status": 200,
    "traceId": "7f571f5a59e89ffa",
    "data": {
        "tenant_name": "t1",
        "tenant_id": 1002,
        "created_time": "2024-10-14T10:26:55.086821+08:00",
        "mode": "MYSQL",
        "status": "NORMAL",
        "locked": "NO",
        "primary_zone": "RANDOM",
        "locality": "FULL{1}@zone2, FULL{1}@zone3",
        "in_recyclebin": "NO",
        "charset": "",
        "collation": "",
        "whitelist": "%,127.0.0.1",
        "pools": [
            {
                "pool_name": "t1_zone2_1728872814",
                "pool_id": 1002,
                "zone_list": "zone2",
                "unit_num": 1,
                "unit_config": {
                    "create_time": "2024-10-14T10:26:41.286401+08:00",
                    "modify_time": "2024-10-14T10:26:41.286401+08:00",
                    "unit_config_id": 1001,
                    "name": "s1",
                    "max_cpu": 2,
                    "min_cpu": 2,
                    "memory_size": 2147483648,
                    "log_disk_size": 6442450944,
                    "max_iops": 9223372036854775807,
                    "min_iops": 9223372036854775807
                }
            },
            {
                "pool_name": "t1_zone3_1728872814",
                "pool_id": 1003,
                "zone_list": "zone3",
                "unit_num": 1,
                "unit_config": {
                    "create_time": "2024-10-14T10:26:41.286401+08:00",
                    "modify_time": "2024-10-14T10:26:41.286401+08:00",
                    "unit_config_id": 1001,
                    "name": "s1",
                    "max_cpu": 2,
                    "min_cpu": 2,
                    "memory_size": 2147483648,
                    "log_disk_size": 6442450944,
                    "max_iops": 9223372036854775807,
                    "min_iops": 9223372036854775807
                }
            }
        ]
    }
}

调用说明

请求路径

返回结果

示例

请求示例

返回示例

相关文档