edit-icon download-icon

Query PID

Last Updated: Sep 19, 2018


OnsPublishGet interface queries detailed information of the specified PID.


The OnsPublishGet interface is called to display and query publishing information.

Request parameters

Name Type Required Description
OnsRegionId String Yes The region where the queried MQ is currently located. It can be obtained through the OnsRegionList method.
OnsPlatform String No The source of the request, which by default is POP platform.
PreventCache Long Yes It’s used for CSRF verification. Set it to the current system time.
ProducerId String Yes PID of the publishing relation to be queried.
Topic String Yes The topic to be queried.

Response parameters

Name Type Description
RequestId String A public parameter unique for each request
HelpUrl String A help link
Data List(PublishInfoDo) A set of query results

PublishInfoDo data structure

Member Type Description
id Long ID of the publishing information in the database
channelId Integer The ID of the region where the Topic is located, including 0-ALIYUN, 1-CLOUD, 2, 3, and 4
channelName String The name of the region where the Topic is located. ALIYUN for Alibaba Cloud, CLOUD for Tmall Cloud…
onsRegionId Long The ID of the region where the Topic is located; obtained through the OnsRegionList method.
regionName String The name of the region where the Topic is located.
Topic String The Topic name
owner String The number of the Topic owner
relation Integer Numbers of all relations. 1 for the owner, 2 for “publish”, 4 for “subscribe”, and 6 for “publish and subscribe”.
relationName String Names of all relations such as the owner, “subscribe”, “publish”, and “publish and subscribe”.
status Integer Number of the current status. (0 for “in service”, 1 for “frozen”, and 2 for “paused”)
statusName String The alias of the current status (“in service”, “frozen”, and “paused”)
appkey Integer null
createTime Long Creation time
updateTime Long Update time
remark String An optional note
  • OnsPublishDelete: deletes a publishing relation
  • OnsPublishList: retrieves a list of publishing relations
  • OnsPublishCreate: creates a publishing relation


This example shows the process of querying a PID named “PID_Mingduan” in the daily region, and printing the main attributes.

  1. public static void main(String []args) {
  2. String regionId = "cn-hangzhou";
  3. String accessKey = "XXXXXXXXXXXXXXXXX";
  4. String secretKey = "XXXXXXXXXXXXXXXXX";
  5. String endPointName ="cn-hangzhou";
  6. String productName ="Ons";
  7. String domain ="ons.cn-hangzhou.aliyuncs.com";
  8. /**
  9. *Select Region based on the region you will access, and set the corresponding access point.
  10. */
  11. try {
  12. DefaultProfile.addEndpoint(endPointNameregionIdproductNamedomain);
  13. } catch (ClientException e) {
  14. e.printStackTrace();
  15. }
  16. IClientProfile profile= DefaultProfile.getProfile(regionIdaccessKeysecretKey);
  17. IAcsClient iAcsClient= new DefaultAcsClient(profile);
  18. OnsPublishGetRequest request = new OnsPublishGetRequest();
  19. /**
  20. *OnsRegionId refers to the resource of the region of MQ required to be accessed by API.
  21. *This value must be selected and configured by the list obtained through the OnsRegionList method because OnsRegionId is changing, and cannot be written as a fixed value.
  22. */
  23. request.setOnsRegionId("daily");
  24. request.setPreventCache(System.currentTimeMillis());
  25. request.setAcceptFormat(FormatType.JSON);
  26. request.setTopic("MingduanTest");
  27. request.setProducerId("PID_Mingduan");
  28. try {
  29. OnsPublishGetResponse response=iAcsClient.getAcsResponse(request);
  30. List<OnsPublishGetResponse.PublishInfoDo> publishInfoDoList =response.getData();
  31. for (OnsPublishGetResponse.PublishInfoDo publishInfoDo:publishInfoDoList){
  32. System.out.println(publishInfoDo.getId()+" "+
  33. publishInfoDo.getChannelId()+" "+
  34. publishInfoDo.getChannelName()+" "+
  35. publishInfoDo.getOnsRegionId()+" "+
  36. publishInfoDo.getRegionName()+" "+
  37. publishInfoDo.getOwner()+" "+
  38. publishInfoDo.getProducerId()+" "+
  39. publishInfoDo.getTopic()+" "+
  40. publishInfoDo.getStatus()+" "+
  41. publishInfoDo.getStatusName()+" "+
  42. publishInfoDo.getCreateTime()+" "+
  43. publishInfoDo.getUpdateTime());
  44. }
  45. } catch (ServerException e) {
  46. e.printStackTrace();
  47. } catch (ClientException e) {
  48. e.printStackTrace();
  49. }
  50. }
Thank you! We've received your feedback.