检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 实例管理类接口 API 说明 生命周期管理 包括创建实例、查询所有实例列表、查询指定实例、删除指定实例、修改实例信息、批量删除实例。 实例管理 包括重置密码、查询插件列表、开启或关闭插件。 规格变更管理 包括查询可扩容规格列表、实例规格变更。 Vhost管理 包
历史API API V1 API V2
API V2 查询产品规格列表 父主题: 历史API
如何调用API 构造请求 认证鉴权 返回结果
API V1 实例管理类接口 其他接口 父主题: 历史API
查询指定实例 当前页面API为历史版本API,未来可能停止维护。请使用查询指定实例。 功能介绍 查询指定实例的详细信息。 URI GET /v1.0/{project_id}/instances/{instance_id} 参数说明见表1。 表1 参数说明 参数 类型 必选 说明
查询可用区信息 当前页面API为历史版本API,未来可能停止维护。请使用查询可用区信息。 功能介绍 在创建实例时,需要配置实例所在的可用区ID,可通过该接口查询可用区的ID。 URI GET /v1.0/availableZones 请求消息 请求参数 无。 请求示例 无。 响应消息
查询产品规格列表 功能介绍 在创建实例时,需要配置订购的产品ID(即product_id),可通过该接口查询产品规格。 当前页面API为历史版本API,未来可能停止维护。请使用查询产品规格列表。 URI GET /v2/products 表1 Query参数 参数 是否必选 参数类型
查询实例标签 功能介绍 查询实例标签。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rabbitmq/{instance_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
查询维护时间窗时间段 当前页面API为历史版本API,未来可能停止维护。请使用查询维护时间窗时间段。 功能介绍 查询维护时间窗开始时间和结束时间。 URI GET /v1.0/instances/maintain-windows 请求消息 请求参数 无。 请求示例 无。 响应消息
查询产品规格列表 当前页面API为历史版本API,未来可能停止维护。请使用查询产品规格列表。 功能介绍 在创建实例时,需要配置订购的产品ID(即product_id),可通过该接口查询产品规格。 URI GET /v1.0/products?engine={engine} 参数说明见表1。
API V2(推荐) 生命周期管理 实例管理 规格变更管理 Vhost管理 Exchange管理 Queue管理 Binding管理 用户管理 后台任务管理 标签管理 其他接口
查询所有实例列表 当前页面API为历史版本API,未来可能停止维护。请使用查询所有实例列表。 功能介绍 查询租户的实例列表,支持按照条件查询。 URI GET /v1.0/{project_id}/instances?engine={engine}&name={name}&sta
@ 请求示例 查询指定实例的详细信息。 GET https://{endpoint}/v2/{project_id}/instances/{instance_id} 响应示例 状态码: 200 查询指定实例成功。 查询指定实例成功。 { "name" : "api-explorer"
查询指定Queue详情 功能介绍 查询指定Queue详情。 调用方法 请参见如何调用API。 URI GET /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues/{queue} 表1 路径参数
查询项目标签 功能介绍 查询项目标签。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rabbitmq/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 请求参数
查询插件列表 功能介绍 查询插件列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id}/rabbitmq/plugins 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
是否必选 参数类型 描述 offset 否 String 分页查询偏移量,表示从此偏移量开始查询,offset大于等于0,默认从0开始查询。 limit 否 String 分页查询单页数量,取值范围0~50,默认查询10条。 请求参数 无 响应参数 状态码: 200 表3 响应Body参数
查询可用区信息 功能介绍 在创建实例时,需要配置实例所在的可用区ID,可通过该接口查询可用区的ID。 调用方法 请参见如何调用API。 URI GET /v2/available-zones 请求参数 无 响应参数 状态码: 200 表1 响应Body参数 参数 参数类型 描述 region_id
是否必选 参数类型 描述 offset 否 Integer 分页查询偏移量,表示从此偏移量开始查询,offset大于等于0,默认从0开始查询。 limit 否 Integer 分页查询单页数量,取值范围0~50,默认查询10条。 请求参数 无 响应参数 状态码: 200 表3 响应Body参数