DescribeConsumerChannel - Data Transmission Service: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeConsumerChannel	Operação a ser executada. Defina o valor como DescribeConsumerChannel.
RegionId	String	Sim	cn-hangzhou	ID da região onde reside a instância de rastreamento de alterações. Para mais informações, consulte Lista de regiões suportadas.
DtsInstanceId	String	Não	dtsboss6pn1w******	ID da instância de rastreamento de alterações. Chame a operação DescribeDtsJobs para consultar o ID da instância. Nota Especifique pelo menos um dos parâmetros DtsInstanceId ou DtsJobId.
DtsJobId	String	Não	boss6pn1w******	ID da tarefa de rastreamento de alterações. Chame a operação DescribeDtsJobs para consultar o ID da tarefa. Nota Especifique pelo menos um dos parâmetros DtsInstanceId ou DtsJobId.
PageSize	Integer	Não	20	Número de entradas retornadas por página. Valores válidos: 1 a 100. Valor padrão: 20.
PageNumber	Integer	Não	1	Número da página a retornar. O valor deve ser um inteiro maior que 0 e não pode exceder o valor máximo do tipo de dados Integer. Valor padrão: 1.
ParentChannelId	String	Não	dtsan5114c52******	ID da tarefa pai da tarefa distribuída.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	String	200	Código de status HTTP.
RequestId	String	D66140B3-C747-42B6-8315-BAF6490E****	ID da solicitação.
ErrCode	String	InternalError	Código de erro retornado em caso de falha na solicitação.
PageRecordCount	Integer	20	Número máximo de grupos de consumidores exibidos por página.
Success	String	true	Indica se a solicitação foi bem-sucedida.
TotalRecordCount	Long	1	Número total de grupos de consumidores.
ErrMessage	String	The request processing has failed due to some unknown error.	Mensagem de erro retornada em caso de falha na solicitação.
PageNumber	Integer	1	Número da página retornada.
ConsumerChannels	Array of ConsumerChannel		Detalhes dos grupos de consumidores.
ConsumerGroupUserName	String	dtstest	Nome de usuário do grupo de consumidores.
ConsumerGroupId	String	dtsor2y66j4219****	ID do grupo de consumidores.
MessageDelay	Long	1500	Latência da mensagem. Corresponde ao timestamp dos dados mais recentes consumidos pelo cliente downstream subtraído do timestamp dos dados mais recentes rastreados pela tarefa de rastreamento de alterações. O valor é um timestamp UNIX. Unidade: segundos. Por exemplo, se os dados mais recentes no banco de dados source forem gerados às 10:00, a tarefa de rastreamento de alterações ler os dados das 09:55 e o cliente downstream consumir os dados das 09:30, a latência da mensagem será a diferença em timestamp UNIX entre 09:55 e 09:30. Nota Se o valor retornado deste parâmetro for -1, nenhum cliente está conectado ao grupo de consumidores.
ConsumerGroupName	String	Consumer Group A	Nome do grupo de consumidores.
ConsumptionCheckpoint	String	2021-06-20T12:00:00Z	Checkpoint de consumo. Representa o momento em que o cliente de rastreamento de alterações consumiu o registro de dados mais recente. O horário segue o formato yyyy-MM-ddTHH:mm:ssZ em UTC.
UnconsumedData	Long	186600	Número total de mensagens não consumidas. Corresponde à soma dos registros de dados não consumidos com as mensagens de heartbeat. Nota Se o valor retornado deste parâmetro for -1, nenhum cliente está conectado ao grupo de consumidores.

Exemplos

Exemplos de solicitações

http(s)://dts.aliyuncs.com/?Action=DescribeConsumerChannel
&RegionId=cn-hangzhou
&DtsInstanceId=dtsboss6pn1w******

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeConsumerChannelResponse>
    <TotalRecordCount>1</TotalRecordCount>
    <PageRecordCount>20</PageRecordCount>
    <RequestId>D66140B3-C747-42B6-8315-BAF6490E****</RequestId>
    <PageNumber>1</PageNumber>
    <HttpStatusCode>200</HttpStatusCode>
    <ConsumerChannels>
        <ConsumptionCheckpoint/>
        <ConsumerGroupId>dtsor2y66j4219****</ConsumerGroupId>
        <ConsumerGroupUserName>dtstest</ConsumerGroupUserName>
        <ConsumerGroupName>Consumer Group A</ConsumerGroupName>
        <MessageDelay>-1</MessageDelay>
        <UnconsumedData>-1</UnconsumedData>
    </ConsumerChannels>
    <Success>true</Success>
</DescribeConsumerChannelResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 1,
  "PageRecordCount" : 20,
  "RequestId" : "D66140B3-C747-42B6-8315-BAF6490E****",
  "PageNumber" : 1,
  "HttpStatusCode" : 200,
  "ConsumerChannels" : [ {
    "ConsumptionCheckpoint" : "",
    "ConsumerGroupId" : "dtsor2y66j4219****",
    "ConsumerGroupUserName" : "dtstest",
    "ConsumerGroupName" : "Consumer Group A",
    "MessageDelay" : -1,
    "UnconsumedData" : -1
  } ],
  "Success" : true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Throttling.User	Request was denied due to user flow control.	Mensagem retornada porque o número de solicitações excedeu o limite e a solicitação foi rejeitada. Tente novamente mais tarde.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	Mensagem retornada porque a resposta do servidor expirou ou o servidor estava indisponível. Tente novamente. Se o erro persistir, entre em contato com o suporte técnico.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	Mensagem retornada porque a assinatura expirou. Utilize uma nova assinatura.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.