TopicExist - 判断 Topic 是否存在--云原生消息引擎-火山引擎

文档中心

立即注册

导航

TopicExist - 判断 Topic 是否存在

最近更新时间：2024.12.11 15:34:46首次发布时间：2023.08.16 14:03:24

调用 TopicExist 接口，判断 Topic 是否存在。

请求说明

请求方式：GET
请求地址：?Action=TopicExist&Version=2023-06-01

请求参数-Query

支持根据 TopicId 和 TopicName 判断目标 Topic 是否存在，请根据需要选择判断方式。

根据 TopicId 查询

参数	类型	是否必选	示例值	描述
Action	String	是	`TopicExist`	接口名称。当前 API 的名称为 `TopicExist`。
Version	String	是	`2023-06-01`	接口版本。当前 API 的版本为 `2023-06-01`。
TopicId	String	是	f129bb8ddb5e**09a9133a9ce5	Topic ID。

根据 TopicName 查询

参数	类型	是否必选	示例值	描述
Action	String	是	`TopicExist`	接口名称。当前 API 的名称为 `TopicExist`。
Version	String	是	`2023-06-01`	接口版本。当前 API 的版本为 `2023-06-01`。
InstanceId	String	是	o-00o**8bg3	实例 ID。
TopicName	String	是	doc-topic-1	Topic 名称。

返回参数

参数	类型	示例值	描述
Existed	Boolean	true	Topic 是否存在： true：存在 false：不存在

参数

类型

示例值

描述

Existed

Boolean

true

Topic 是否存在：

true：存在
false：不存在

请求参数

GET https://open.volcengineapi.com?Action=TopicExist&Version=2023-06-01&TopicId=f129bb8ddb5e**09a9133a9ce5
Content-Type: application/json
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/bmq/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20230815172**29A1057A",
        "Action": "TopicExist",
        "Version": "2023-06-01",
        "Service": "bmq",
        "Region": "cn-beijing"
    },
    "Result": {
        "Existed": true
    }
}