列出主题

本文档介绍了如何列出 Pub/Sub 主题。要列出 可以使用 Google Cloud 控制台、gcloud CLI、客户端库 或 Pub/Sub API

准备工作

所需的角色和权限

如需获得列出主题和管理主题所需的权限，请让您的管理员为您授予主题或项目的 Pub/Sub Editor(roles/pubsub.editor) IAM 角色。 如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

此预定义角色包含 列出和管理主题所需的权限。如需查看所需的确切权限，请展开所需权限部分：

所需权限

要列出和管理主题，您需要拥有以下权限：

  • 创建主题： pubsub.topics.create
  • 删除主题： pubsub.topics.delete
  • 将订阅与主题分离： pubsub.topics.detachSubscription
  • 获取主题： pubsub.topics.get
  • 列出主题： pubsub.topics.list
  • 发布到主题： pubsub.topics.publish
  • 更新主题： pubsub.topics.update
  • 获取主题的 IAM 政策： pubsub.topics.getIamPolicy
  • 为主题配置 IAM 政策： pubsub.topics.setIamPolicy

您也可以使用自定义角色或其他预定义角色来获取这些权限。

您可以在项目级和单个项目级 资源层级。您可以在一个项目中创建订阅，然后 将其附加到其他项目中的主题。 确保您拥有 资源。

列出主题

控制台

  • 在 Google Cloud 控制台中，转到 Pub/Sub 主题页面。

    • 转到“主题”

    主题页面列出了所有可用的主题。

    默认情况下，控制台会返回 50 个主题。您可以将此值提高到 每页行数下拉切换开关最多可返回 200 个主题。 仅当您的项目中的主题超过 20 个时，控制台中才会显示此切换开关。

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. 如需列出主题，请使用 gcloud pubsub topics list 命令：

    gcloud pubsub topics list

默认情况下，每个查询最多返回 100 个结果。 您可以使用页面大小参数指定一个其他值（最高 1,000）。 例如，使用 Google Cloud CLI 指定 --page-size=1000。

REST

如需列出主题，请使用 projects.topics.list 方法：

请求：

必须使用 Authorization 标头中的访问令牌对请求进行身份验证。如需获取当前应用默认凭据的访问令牌，请运行以下命令：gcloud auth application-default print-access-token。

GET https://pubsub.googleapis.com/v1/projects/PROJECT_ID/topics
Authorization: Bearer ACCESS_TOKEN

其中：

  • PROJECT_ID 是项目 ID。

    • 回答：

    {
  "topics": [
    {
      "name": "projects/PROJECT_ID/topics/mytopic1",
      ...
    },
    {
      "name": "projects/PROJECT_ID/topics/mytopic2",
      ...
    }
  ]
}

    C++

    在尝试此示例之前，请按照C++ Pub/Sub 快速入门： 客户端库。 如需了解详情，请参阅 Pub/Sub C++ API 参考文档。

    如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

    namespace pubsub_admin = ::google::cloud::pubsub_admin;
[](pubsub_admin::TopicAdminClient client, std::string const& project_id) {
  int count = 0;
  for (auto& topic : client.ListTopics("projects/" + project_id)) {
    if (!topic) throw std::move(topic).status();
    std::cout << "Topic Name: " << topic->name() << "\n";
    ++count;
  }
  if (count == 0) {
    std::cout << "No topics found in project " << project_id << "\n";
  }
}

    C#

    在尝试此示例之前，请按照 Pub/Sub 快速入门：使用客户端库中的 C# 设置说明进行操作。 如需了解详情，请参阅 Pub/Sub C# API 参考文档。

    如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

    
using Google.Api.Gax.ResourceNames;
using Google.Cloud.PubSub.V1;
using System.Collections.Generic;

public class ListProjectTopicsSample
{
    public IEnumerable<Topic> ListProjectTopics(string projectId)
    {
        PublisherServiceApiClient publisher = PublisherServiceApiClient.Create();
        ProjectName projectName = ProjectName.FromProject(projectId);
        IEnumerable<Topic> topics = publisher.ListTopics(projectName);
        return topics;
    }
}

    Go

    在尝试此示例之前，请按照Go Pub/Sub 快速入门： 客户端库。 有关详情，请参阅 Pub/Sub Go API 参考文档。

    如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

    import (
	"context"
	"fmt"

	"cloud.google.com/go/pubsub"
	"google.golang.org/api/iterator"
)

func list(projectID string) ([]*pubsub.Topic, error) {
	// projectID := "my-project-id"
	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return nil, fmt.Errorf("pubsub.NewClient: %w", err)
	}
	defer client.Close()

	var topics []*pubsub.Topic

	it := client.Topics(ctx)
	for {
		topic, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return nil, fmt.Errorf("Next: %w", err)
		}
		topics = append(topics, topic)
	}

	return topics, nil
}

    Java

    在尝试此示例之前，请按照Java Pub/Sub 快速入门： 客户端库。 如需了解详情，请参阅 Pub/Sub Java API 参考文档。

    如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

    
import com.google.cloud.pubsub.v1.TopicAdminClient;
import com.google.pubsub.v1.ProjectName;
import com.google.pubsub.v1.Topic;
import java.io.IOException;

public class ListTopicsExample {
  public static void main(String... args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "your-project-id";

    listTopicsExample(projectId);
  }

  public static void listTopicsExample(String projectId) throws IOException {
    try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
      ProjectName projectName = ProjectName.of(projectId);
      for (Topic topic : topicAdminClient.listTopics(projectName).iterateAll()) {
        System.out.println(topic.getName());
      }
      System.out.println("Listed all topics.");
    }
  }
}

    Node.js

    // Imports the Google Cloud client library
const {PubSub} = require('@google-cloud/pubsub');

// Creates a client; cache this for further use
const pubSubClient = new PubSub();

async function listAllTopics() {
  // Lists all topics in the current project
  const [topics] = await pubSubClient.getTopics();
  console.log('Topics:');
  topics.forEach(topic => console.log(topic.name));
}

    Node.js

    // Imports the Google Cloud client library
import {PubSub, Topic} from '@google-cloud/pubsub';

// Creates a client; cache this for further use
const pubSubClient = new PubSub();

async function listAllTopics() {
  // Lists all topics in the current project
  const [topics] = await pubSubClient.getTopics();
  console.log('Topics:');
  topics.forEach((topic: Topic) => console.log(topic.name));
}

    PHP

    在尝试此示例之前，请按照PHP Pub/Sub 快速入门： 客户端库。 有关详情，请参阅 Pub/Sub PHP API 参考文档。

    如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

    use Google\Cloud\PubSub\PubSubClient;

/**
 * Lists all Pub/Sub topics.
 *
 * @param string $projectId  The Google project ID.
 */
function list_topics($projectId)
{
    $pubsub = new PubSubClient([
        'projectId' => $projectId,
    ]);
    foreach ($pubsub->topics() as $topic) {
        printf('Topic: %s' . PHP_EOL, $topic->name());
    }
}

    Python

    在尝试此示例之前，请按照Python Pub/Sub 快速入门： 客户端库。 有关详情，请参阅 Pub/Sub Python API 参考文档。

    如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

    from google.cloud import pubsub_v1

# TODO(developer)
# project_id = "your-project-id"

publisher = pubsub_v1.PublisherClient()
project_path = f"projects/{project_id}"

for topic in publisher.list_topics(request={"project": project_path}):
    print(topic)

    Ruby

    在尝试此示例之前，请按照Ruby Pub/Sub 快速入门： 客户端库。 有关详情，请参阅 Pub/Sub Ruby API 参考文档。

    如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

    
pubsub = Google::Cloud::Pubsub.new

topics = pubsub.topics

puts "Topics in project:"
topics.each do |topic|
  puts topic.name
end

    后续步骤