Listar metadados de runtime de partição

Artigo
08/05/2023

Retorna os metadados de todas as partições em um Hub de Eventos. Consulte Propriedades de descrição da partição.

Solicitação

Método	URI da solicitação
GET	`https://{servicebusNamespace}.servicebus.windows.net/{eventHubPath}/consumergroups/{consumergroupName}/partitions`

Cabeçalhos de solicitação

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros que são usados por todas as solicitações relacionadas aos Hubs de Eventos.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Nome do elemento	Obrigatório	Tipo	Versão	Descrição
`SizeInBytes`	Sim, somente leitura	INT	2014-01	O tamanho aproximado, em bytes, da partição dos Hubs de Eventos.
`BeginSequenceNumber`	Sim, somente leitura	string	2014-01	O número de sequência inicial.
`EndSequenceNumber`	Sim, somente leitura	string	2014-01	O número da sequência final.
`IncomingBytesPerSecond`	Sim, somente leitura	string	2014-01	A taxa aproximada de entrada de eventos (em bytes por segundo) para a partição nesse grupo de consumidores.
`OutgoingBytesPerSecond`	Sim, somente leitura	string	2014-01	A taxa de saída aproximada (em bytes por segundo) para a partição nesse grupo de consumidores.
`LastEnqueuedOffset`	Sim, somente leitura	string	2015-01	O deslocamento do último evento enfileirado.
`LastEnqueuedTimeUtc`	Sim, somente leitura	string	2015-01	A hora em UTC em que o último evento foi enfileirado.

Códigos de resposta

Código	Descrição
200	Êxito.
401	Falha de autorização.
500	Erro interno.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá a descrição de todas as partições do Hub de Eventos especificado. Se a solicitação não tiver êxito, o corpo conterá um código de erro e uma mensagem de erro.

Exemplos

Solicitação

Observação

Você também pode usar um token do Azure Active Directory para o cabeçalho De autorização , conforme observado nos parâmetros e cabeçalhos Comuns. Por exemplo: Authorization: Bearer <Azure AD token>.

GET https://your-namespace.servicebus.windows.net/your-event-hub//consumergroups/$Default/partitions/0?timeout=60&api-version=2015-01 HTTP/1.1  
Authorization: SharedAccessSignature sr=your-namespace.servicebus.windows.net&sig=your-sas-key&se=1456273000&skn=RootManageSharedAccessKey  
Content-Type: application/atom+xml;type=entry;charset=utf-8  
Host: your-namespace.servicebus.windows.net

Resposta

HTTP/1.1 200 OK  
Content-Type: application/atom+xml;type=feed;charset=utf-8  
Server: Microsoft-HTTPAPI/2.0  
Date: Tue, 23 Feb 2016 23:36:42 GMT  
Content-Length: 2252  
  
<?xml version="1.0" encoding="UTF-8"?>  
<feed xmlns="http://www.w3.org/2005/Atom">  
   <title type="text">Partitions</title>  
   <id>https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/$Default/partitions?timeout=60&api-version=2015-01</id>  
   <updated>2016-02-23T23:36:42Z</updated>  
   <link rel="self" href="https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/$Default/partitions?timeout=60&api-version=2014-01" />  
   <entry xml:base="https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/$Default/partitions?timeout=60&api-version=2014-01">  
      <id>https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/$Default/partitions/0?api-version=2015-01</id>  
      <title type="text">0</title>  
      <published>2015-09-09T20:31:00Z</published>  
      <updated>2015-09-09T20:31:00Z</updated>  
      <link rel="self" href="partitions/0?api-version=2015-01" />  
      <content type="application/xml">  
         <PartitionDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
            <SizeInBytes>33554432</SizeInBytes>  
            <BeginSequenceNumber>0</BeginSequenceNumber>  
            <EndSequenceNumber>20044</EndSequenceNumber>  
            <IncomingBytesPerSecond>0</IncomingBytesPerSecond>  
            <OutgoingBytesPerSecond>0</OutgoingBytesPerSecond>  
            <LastEnqueuedOffset>2062040</LastEnqueuedOffset>  
            <LastEnqueuedTimeUtc>2016-02-23T03:22:27.024Z</LastEnqueuedTimeUtc>  
         </PartitionDescription>  
      </content>  
   </entry>  
   <entry xml:base="https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/$Default/partitions?timeout=60&api-version=2014-01">  
      <id>https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/$Default/partitions/1?api-version=2015-01</id>  
      <title type="text">1</title>  
      <published>2015-09-09T20:31:01Z</published>  
      <updated>2015-09-09T20:31:01Z</updated>  
      <link rel="self" href="partitions/1?api-version=2015-01" />  
      <content type="application/xml">  
         <PartitionDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
            <SizeInBytes>33554432</SizeInBytes>  
            <BeginSequenceNumber>0</BeginSequenceNumber>  
            <EndSequenceNumber>22907</EndSequenceNumber>  
            <IncomingBytesPerSecond>0</IncomingBytesPerSecond>  
            <OutgoingBytesPerSecond>0</OutgoingBytesPerSecond>  
            <LastEnqueuedOffset>2062040</LastEnqueuedOffset>  
            <LastEnqueuedTimeUtc>2016-02-23T03:22:27.024Z</LastEnqueuedTimeUtc>  
         </PartitionDescription>  
      </content>  
   </entry>  
</feed>

Compartilhar via