ListFragments - Amazon Kinesis Video Streams

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

ListFragments

Restituisce un elenco di Fragment oggetti dal flusso e dall'intervallo di timestamp specificati all'interno dei dati archiviati.

L'elenco dei frammenti alla fine è coerente. Ciò significa che, anche se il produttore riceve una conferma che un frammento è persistente, il risultato potrebbe non essere restituito immediatamente da una richiesta a. ListFragments Tuttavia, i risultati sono generalmente disponibili in meno di un secondo.

Nota

È necessario prima chiamare il GetDataEndpoint API per ottenere un endpoint. Quindi invia le ListFragments richieste a questo endpoint utilizzando il parametro --endpoint-url.

Importante

Se viene generato un errore dopo aver richiamato un API supporto archiviato di Kinesis Video Streams, oltre al codice di stato e HTTP al corpo della risposta, include le seguenti informazioni:

  • x-amz-ErrorTypeHTTPheader: contiene un tipo di errore più specifico oltre a quello fornito dal codice di stato. HTTP

  • x-amz-RequestIdHTTPheader: se desideri segnalare un problema AWS, il team di supporto può diagnosticare meglio il problema se gli viene fornito il Request Id.

Sia il codice di HTTP stato che l' ErrorType intestazione possono essere utilizzati per prendere decisioni programmatiche sulla possibilità di riprovare gli errori e in quali condizioni, oltre a fornire informazioni sulle azioni che il programmatore del client potrebbe dover intraprendere per riprovare con successo.

Per ulteriori informazioni, consultate la sezione Errori nella parte inferiore di questo argomento, nonché Errori comuni.

Sintassi della richiesta

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" }

URIParametri della richiesta

La richiesta non utilizza alcun URI parametro.

Corpo della richiesta

La richiesta accetta i seguenti dati nel JSON formato.

FragmentSelector

Descrive l'intervallo di timestamp e l'origine del timestamp per l'intervallo di frammenti da restituire.

Nota

Questo è richiesto solo quando NextToken non viene passato il. API

Tipo: oggetto FragmentSelector

Campo obbligatorio: no

MaxResults

Il numero totale di frammenti da restituire. Se il numero totale di frammenti disponibili è superiore al valore specificato inmax-results, nell'output NextToken viene fornito un ListFragments: che è possibile utilizzare per riprendere l'impaginazione.

Il valore predefinito è 100.

Tipo: long

Intervallo valido: valore minimo di 1. Valore massimo pari a 1000.

Campo obbligatorio: no

NextToken

Token per specificare dove iniziare l'impaginazione. Questo è il ListFragments: di una risposta NextToken troncata in precedenza.

Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 4096.

Modello: [a-zA-Z0-9+/]+={0,2}

Campo obbligatorio: no

StreamARN

L'Amazon Resource Name (ARN) dello stream da cui recuperare un elenco di frammenti. Specificate questo parametro o il StreamName parametro.

Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 1024 caratteri.

Modello: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Campo obbligatorio: no

StreamName

Il nome dello stream da cui recuperare un elenco di frammenti. Specificate questo parametro o il StreamARN parametro.

Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.

Modello: [a-zA-Z0-9_.-]+

Campo obbligatorio: no

Sintassi della risposta

HTTP/1.1 200 Content-type: application/json { "Fragments": [ { "FragmentLengthInMilliseconds": number, "FragmentNumber": "string", "FragmentSizeInBytes": number, "ProducerTimestamp": number, "ServerTimestamp": number } ], "NextToken": "string" }

Elementi di risposta

Se l'azione ha esito positivo, il servizio restituisce una risposta di HTTP 200.

I seguenti dati vengono restituiti in JSON formato dal servizio.

Fragments

Un elenco di Fragment oggetti archiviati dallo stream che soddisfano i criteri di selezione. I risultati non sono in ordine specifico, nemmeno tra le pagine.

Se nello stream non sono presenti frammenti che soddisfano i criteri del selettore, viene restituito un elenco vuoto.

Tipo: matrice di oggetti Fragment

NextToken

Se l'elenco restituito viene troncato, l'operazione restituisce questo token da utilizzare per recuperare la pagina successiva di risultati. Questo valore è null quando non ci sono altri risultati da restituire.

Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 4096.

Modello: [a-zA-Z0-9+/]+={0,2}

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

ClientLimitExceededException

Kinesis Video Streams ha limitato la richiesta perché hai superato un limite. Prova a effettuare la chiamata più tardi. Per informazioni sui limiti, consulta la sezione Quote di Kinesis Video Streams.

HTTPCodice di stato: 400

InvalidArgumentException

Un parametro specificato supera le restrizioni, non è supportato o non può essere utilizzato.

HTTPCodice di stato: 400

NotAuthorizedException

Codice di stato: 403, il chiamante non è autorizzato a eseguire un'operazione sullo stream specificato o il token è scaduto.

HTTPCodice di stato: 401

ResourceNotFoundException

GetImagesgenererà questo errore quando Kinesis Video Streams non riesce a trovare lo stream specificato.

GetHLSStreamingSessionURLe GetDASHStreamingSessionURL genera questo errore se LIVE_REPLAY viene richiesta una sessione con un PlaybackMode of ON_DEMAND o per uno stream che non contiene frammenti nell'intervallo di tempo richiesto, o se LIVE viene richiesta una sessione con un PlaybackMode of per uno stream che non contiene frammenti negli ultimi 30 secondi.

HTTPCodice di stato: 404

Vedi anche

Per ulteriori informazioni sull'utilizzo API in una delle lingue specifiche AWS SDKs, consulta quanto segue: