As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
ListFragments
Retorna uma lista de Fragment objetos do intervalo especificado de fluxo e timestamp nos dados arquivados.
A listagem de fragmentos acaba sendo consistente. Isso significa que, mesmo que o produtor receba uma confirmação de que um fragmento persiste, o resultado pode não ser retornado imediatamente de uma solicitação para. ListFragments No entanto, os resultados geralmente estão disponíveis em menos de um segundo.
nota
Você deve primeiro ligar GetDataEndpoint API para o para obter um endpoint. Em seguida, envie as ListFragments solicitações para esse endpoint usando o parâmetro --endpoint-url.
Importante
Se um erro for gerado após invocar uma API mídia arquivada do Kinesis Video Streams, além do código de status e HTTP do corpo da resposta, ele incluirá as seguintes informações:
-
x-amz-ErrorTypeHTTPcabeçalho — contém um tipo de erro mais específico, além do que o código de HTTP status fornece. -
x-amz-RequestIdHTTPcabeçalho — se você quiser relatar um problema AWS, a equipe de suporte poderá diagnosticar melhor o problema se receber o ID da solicitação.
Tanto o código de HTTP status quanto o ErrorType cabeçalho podem ser utilizados para tomar decisões programáticas sobre se os erros podem ser repetidos e sob quais condições, além de fornecer informações sobre quais ações o programador cliente pode precisar realizar para tentar novamente com sucesso.
Para obter mais informações, consulte a seção Erros na parte inferior deste tópico, bem como Erros comuns.
Sintaxe da Solicitação
POST /listFragments HTTP/1.1
Content-type: application/json
{
"FragmentSelector": {
"FragmentSelectorType": "string",
"TimestampRange": {
"EndTimestamp": number,
"StartTimestamp": number
}
},
"MaxResults": number,
"NextToken": "string",
"StreamARN": "string",
"StreamName": "string"
}URIParâmetros de solicitação
A solicitação não usa nenhum URI parâmetro.
Corpo da Solicitação
A solicitação aceita os seguintes dados no JSON formato.
- FragmentSelector
-
Descreve o intervalo do carimbo de data/hora e a origem do carimbo de data/hora para o intervalo de fragmentos a serem retornados.
nota
Isso só é necessário quando o
NextTokennão é passado noAPI.Tipo: objeto FragmentSelector
Obrigatório: Não
- MaxResults
-
O número total de fragmentos a serem devolvidos. Se o número total de fragmentos disponíveis for maior que o valor especificado em
max-results, um ListFragments: será NextToken fornecido na saída que você pode usar para retomar a paginação.O valor padrão é 100.
Tipo: longo
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.
Obrigatório: Não
- NextToken
-
Um token para especificar onde iniciar a paginação. Este é o ListFragments: NextToken de uma resposta previamente truncada.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 4.096.
Padrão:
[a-zA-Z0-9+/]+={0,2}Obrigatório: Não
- StreamARN
-
O Amazon Resource Name (ARN) do stream do qual recuperar uma lista de fragmentos. Especifique esse parâmetro ou o
StreamNameparâmetro.Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.
Padrão:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Obrigatório: Não
- StreamName
-
O nome do fluxo do qual recuperar uma lista de fragmentos. Especifique esse parâmetro ou o
StreamARNparâmetro.Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.
Padrão:
[a-zA-Z0-9_.-]+Obrigatório: Não
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"Fragments": [
{
"FragmentLengthInMilliseconds": number,
"FragmentNumber": "string",
"FragmentSizeInBytes": number,
"ProducerTimestamp": number,
"ServerTimestamp": number
}
],
"NextToken": "string"
}Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.
Os dados a seguir são retornados em JSON formato pelo serviço.
- Fragments
-
Uma lista de Fragment objetos arquivados do stream que atendem aos critérios do seletor. Os resultados não estão em uma ordem específica, mesmo entre páginas.
Se não houver fragmentos no fluxo que atendam aos critérios do seletor, uma lista vazia será retornada.
Tipo: matriz de objetos Fragment
- NextToken
-
Se a lista retornada for truncada, a operação retornará esse token para ser usado na recuperação da próxima página de resultados. Esse valor é
nullquando não há mais resultados a serem retornados.Tipo: string
Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 4.096.
Padrão:
[a-zA-Z0-9+/]+={0,2}
Erros
Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.
- ClientLimitExceededException
-
O Kinesis Video Streams limitou a solicitação porque você excedeu um limite. Tente fazer a ligação mais tarde. Para obter informações sobre limites, consulte Cotas do Kinesis Video Streams.
HTTPCódigo de status: 400
- InvalidArgumentException
-
Um parâmetro especificado excede suas restrições, não é suportado ou não pode ser usado.
HTTPCódigo de status: 400
- NotAuthorizedException
-
Código de status: 403, O chamador não está autorizado a realizar uma operação no stream fornecido ou o token expirou.
HTTPCódigo de status: 401
- ResourceNotFoundException
-
GetImagesgerará esse erro quando o Kinesis Video Streams não conseguir encontrar o stream que você especificou.GetHLSStreamingSessionURLeGetDASHStreamingSessionURLgere esse erro se uma sessão com umPlaybackModedeON_DEMANDouLIVE_REPLAYfor solicitada para um fluxo que não tem fragmentos dentro do intervalo de tempo solicitado, ou se uma sessão com umPlaybackModeofLIVEfor solicitada para um fluxo que não tem fragmentos nos últimos 30 segundos.HTTPCódigo de status: 404
Consulte também
Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte:
