更新时间:2025-09-03 GMT+08:00
查询Vhost列表
功能介绍
查询Vhost列表。
URI
GET /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 分页查询偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0。 |
limit |
否 |
Integer |
参数解释: 分页查询单页数量。 约束限制: 不涉及。 取值范围: 0~50。 默认取值: 10。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
size |
Integer |
参数解释: 当前显示的Vhost数量 取值范围: 不涉及。 |
total |
Integer |
参数解释: 查询到的Vhost总数 取值范围: 不涉及。 |
items |
Array of ShowVhostDetailResp objects |
参数解释: 查询的Vhost信息列表 |
请求示例
查询Vhost列表
GET https://{endpoint}/v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts?offset=0&limit=10
响应示例
状态码:200
获取Vhost列表成功
{ "size" : 10, "total" : 13, "items" : [ { "name" : "/", "tracing" : false }, { "name" : "test-vhost1", "tracing" : false }, { "name" : "test-vhost10", "tracing" : false }, { "name" : "test-vhost2", "tracing" : false }, { "name" : "test-vhost3", "tracing" : false }, { "name" : "test-vhost4", "tracing" : false }, { "name" : "test-vhost5", "tracing" : false }, { "name" : "test-vhost6", "tracing" : false }, { "name" : "test-vhost7", "tracing" : false }, { "name" : "test-vhost8", "tracing" : false } ] }
状态码
状态码 |
描述 |
---|---|
200 |
获取Vhost列表成功 |
错误码
请参见错误码。
父主题: Vhost管理