更新时间:2025-09-24 GMT+08:00
分享

查询所有区域信息

典型场景

多集群场景使用,三方系统对接,使用访问控制器Global IP获取各区域信息的接口。

接口功能

多集群场景下,提供北向获取各区域信息功能。

接口约束

多集群场景下,使用Global IP地址。

调用方法

GET

URI

/controller/campus/api/v1/multiregion/regions

请求参数

请求示例

HTTP的示例
GET /controller/campus/api/v1/multiregion/regions HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json;charset=UTF-8
Accept: application/json

响应参数

返回状态码为200:设置成功

表1 AllRegionInfoOut对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

0~128个字符。

-

错误码

"0"

errmsg

string

0~128个字符。

-

错误信息

""

data

ARRAY_REFERENCE

0-9个列表项,详细请参见表2

各区域信息返回结果

-

表2 RegionInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

regionId

string

0~36个字符。

-

区域ID

"ccea2143-3245-4e36-b1ca-4aa3a800bff4"

regionName

string

0~128个字符。

-

区域名称

"Region1"

regionFloatIp

string

1~64个字符。

-

北向浮动ip或域名

"192.168.1.2"

status

string

0~32个字符。

-

区域的状态,取值范围:normal、disconnected

"normal"

返回状态码为400:查询失败

详细信息请参见实际响应消息体。

响应示例

返回状态码为200:设置成功

HTTP/1.1 200 OK
Date: Wed,24 Sep 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
	"errcode" : "0",
	"errmsg" : "",
	"data" : [
		{
			"regionId" : "ccea2143-3245-4e36-b1ca-4aa3a800bff4",
			"regionName" : "Region1",
			"regionFloatIp" : "192.168.1.2",
			"status" : "normal"
		}
	]
}

返回状态码为400:查询失败

HTTP/1.1 400 Bad Request
Date: Wed,24 Sep 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

相关文档