使用 OnsTopicList 查询账号下所有 Topic 的信息列表。

本接口一般用于生成资源列表的场景,并不查看具体信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsTopicList

系统规定参数。取值:OnsTopicList。

InstanceId String MQ_INST_111111111111_DOxxxxxx

需获取的 Topic 信息列表所对应的实例 ID。

Topic String test

查询指定 Topic 时设置,否则查询所有 Topic。

返回数据

名称 类型 示例值 描述
Data Array

返回所有已发布的 Topic 信息列表。

PublishInfoDo
CreateTime Long 1570700947000

创建时间。

IndependentNaming Boolean true

Topic 所在实例是否有命名空间。取值说明如下:

  • true:拥有独立命名空间,资源命名确保实例内唯一,跨实例之间可重名。
  • false:无独立命名空间,实例内或者跨实例之间,资源命名必须全局唯一。
InstanceId String MQ_INST_111111111111_DOxxxxxx

Topic 所在的实例 ID。

MessageType Integer 0

消息类型。取值说明如下:

  • 0:普通消息
  • 1:分区顺序消息
  • 2:全局顺序消息
  • 4:事务消息
  • 5:定时/延时消息
Owner String 138015630679****

Topic 所有者编号,为阿里云的账号 ID。

Relation Integer 6

所有关系编号。取值说明如下:

  • 1:持有者
  • 2:可以发布
  • 4:可以订阅
  • 6:可以发布和订阅
RelationName String 授权发布/订阅

所有关系名称,例如持有者、可订阅、可发布、可发布订阅。

Remark String 测试

备注信息。

Topic String test

Topic 名称。

RequestId String 4A978869-7681-4529-B470-107E1379FBF2

为公共参数,每个请求 ID 都是唯一的。

示例

请求示例

http(s)://[Endpoint]/?Action=OnsTopicList
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<OnsTopicListResponse>
  <Data>
        <PublishInfoDo>
              <Relation>6</Relation>
              <Owner>138015630679****</Owner>
              <RelationName>授权发布/订阅</RelationName>
              <IndependentNaming>true</IndependentNaming>
              <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
              <CreateTime>1570700947000</CreateTime>
              <Topic>test</Topic>
              <Remark>测试</Remark>
              <MessageType>0</MessageType>
        </PublishInfoDo>
  </Data>
  <RequestId>4A978869-7681-4529-B470-107E1379FBF2</RequestId>
</OnsTopicListResponse>

JSON 格式

{
	"Data": {
		"PublishInfoDo": [
			{
				"Relation": 6,
				"Owner": "138015630679****",
				"RelationName": "授权发布/订阅",
				"IndependentNaming": true,
				"InstanceId": "MQ_INST_111111111111_DOxxxxxx",
				"CreateTime": 1570700947000,
				"Topic": "test",
				"Remark": "测试",
				"MessageType": 0
			}
		]
	},
	"RequestId": "4A978869-7681-4529-B470-107E1379FBF2"
}

错误码

访问错误中心查看更多错误码。