调用 DescribeProducers 接口，查询实例或 Topic 的生产者连接情况。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeProducers

要执行的操作，取值：DescribeProducers。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceId string 必选示例值：rocketmq-cnai1f0c29ca****

待查询生产者连接的实例 ID。

TopicName string 可选示例值：my_topic

需要查询的 Topic 名称。

说明

不填写该参数时，查询实例下全部生产者连接。

填写该参数时，查询指定 Topic 下的生产者连接。

PageNumber integer 必选示例值：1

查询结果分页展示时，此参数用于表示页码，支持的最小值为 1。

PageSize integer 必选示例值：10

查询结果分页展示时，此参数用于表示每页的数据量，取值范围为 1~100。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

TotalCount integer 示例值：1

符合查询条件的生产者客户端总数。

ProducersInfo object[] 示例值：详情请参见示例代码

符合查询条件的生产者客户端列表。

ProducerGroup string 示例值：producer-group-a

生产者分组。

说明

按实例维度查询时返回该参数。

按 Topic 维度查询时该参数可能为空。

ClientAddress string 示例值：10.60.x.x:xxxxx

该生产者实例的地址和端口。

ClientId string 示例值：192.xxx.xx@16xxxx

该生产者实例的 ID。

Version string 示例值：v4_8_0

生产端版本。

Language string 示例值：JAVA

生产者应用的开发语言。

请求示例 1

返回示例 1

请求示例 2

返回示例 2

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	MissingParameter	The request body is missing a required parameter %s.	缺少%s参数。
400	UnsupportedParameter	The specified parameter %s is unsupported.	不支持%s参数。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	NotModifiedParameter	The resource was not changed.	未变更任何配置。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	InvalidTopicStatus	topic status is invalid.	Topic 状态不合法。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
400	QuotaExceeded	Quota Limited.	资源超配额 quota。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
404	InvalidTopicName.NotFound	The specified topic does not exist.	Topic 不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
500	ResourceIsBusy	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

消息队列 RocketMQ版