ListFragments - Amazon Kinesis Video Streams
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

ListFragments

Mengembalikan daftar Fragment objek dari rentang aliran dan timestamp tertentu dalam data yang diarsipkan.

Daftar fragmen pada akhirnya konsisten. Ini berarti bahwa bahkan jika produsen menerima pengakuan bahwa fragmen dipertahankan, hasilnya mungkin tidak segera dikembalikan dari permintaan ke. ListFragments Namun, hasil biasanya tersedia dalam waktu kurang dari satu detik.

catatan

Anda harus terlebih dahulu memanggil GetDataEndpoint API untuk mendapatkan titik akhir. Kemudian kirim ListFragments permintaan ke titik akhir ini menggunakan parameter --endpoint-url.

penting

Jika kesalahan muncul setelah menjalankan API media yang diarsipkan Kinesis Video Streams, selain kode status HTTP dan badan respons, itu mencakup potongan-potongan informasi berikut:

  • x-amz-ErrorTypeHeader HTTP - berisi jenis kesalahan yang lebih spesifik selain apa yang disediakan kode status HTTP.

  • x-amz-RequestIdHeader HTTP - jika Anda ingin melaporkan masalah AWS, tim dukungan dapat mendiagnosis masalah dengan lebih baik jika diberi ID Permintaan.

Baik kode status HTTP dan ErrorType header dapat digunakan untuk membuat keputusan terprogram tentang apakah kesalahan dapat dicoba ulang dan dalam kondisi apa, serta memberikan informasi tentang tindakan apa yang mungkin perlu dilakukan oleh programmer klien agar berhasil mencoba lagi.

Untuk informasi selengkapnya, lihat bagian Kesalahan di bagian bawah topik ini, serta Kesalahan Umum.

Minta Sintaks

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

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

FragmentSelector

Menjelaskan rentang stempel waktu dan asal stempel waktu untuk rentang fragmen yang akan dikembalikan.

catatan

Ini hanya diperlukan ketika NextToken tidak diteruskan di API.

Tipe: Objek FragmentSelector

Wajib: Tidak

MaxResults

Jumlah total fragmen yang akan dikembalikan. Jika jumlah total fragmen yang tersedia lebih dari nilai yang ditentukan dalammax-results, maka ListFragments: NextToken disediakan dalam output yang dapat Anda gunakan untuk melanjutkan pagination.

Nilai default-nya adalah 100.

Tipe: Long

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 1000.

Wajib: Tidak

NextToken

Token untuk menentukan di mana harus memulai paginating. Ini adalah ListFragments: NextToken dari respons yang sebelumnya terpotong.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 4096.

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

Wajib: Tidak

StreamARN

Nama Sumber Daya Amazon (ARN) dari aliran untuk mengambil daftar fragmen. Tentukan parameter ini atau StreamName parameternya.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

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

Wajib: Tidak

StreamName

Nama aliran dari mana untuk mengambil daftar fragmen. Tentukan parameter ini atau StreamARN parameternya.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.

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

Diperlukan: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "Fragments": [ 
      { 
         "FragmentLengthInMilliseconds": number,
         "FragmentNumber": "string",
         "FragmentSizeInBytes": number,
         "ProducerTimestamp": number,
         "ServerTimestamp": number
      }
   ],
   "NextToken": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

Fragments

Daftar Fragment objek yang diarsipkan dari aliran yang memenuhi kriteria pemilih. Hasil tidak dalam urutan tertentu, bahkan di seluruh halaman.

Jika tidak ada fragmen dalam aliran yang memenuhi kriteria pemilih, daftar kosong dikembalikan.

Tipe: Array objek Fragment

NextToken

Jika daftar yang dikembalikan terpotong, operasi mengembalikan token ini untuk digunakan untuk mengambil halaman hasil berikutnya. Nilai ini adalah null ketika tidak ada lagi hasil untuk dikembalikan.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 4096.

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

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

ClientLimitExceededException

Kinesis Video Streams telah membatasi permintaan karena Anda telah melampaui batas. Coba buat panggilan nanti. Untuk informasi tentang batas, lihat Batas Kinesis Video Streams.

Kode Status HTTP: 400

InvalidArgumentException

Parameter yang ditentukan melebihi batasannya, tidak didukung, atau tidak dapat digunakan.

Kode Status HTTP: 400

NotAuthorizedException

Kode Status: 403, Penelepon tidak berwenang untuk melakukan operasi pada aliran yang diberikan, atau token telah kedaluwarsa.

Kode Status HTTP: 401

ResourceNotFoundException

GetImagesakan memunculkan kesalahan ini ketika Kinesis Video Streams tidak dapat menemukan aliran yang Anda tentukan.

GetHLSStreamingSessionURLdan GetDASHStreamingSessionURL membuang kesalahan ini jika sesi dengan PlaybackMode dari ON_DEMAND atau LIVE_REPLAY diminta untuk aliran yang tidak memiliki fragmen dalam rentang waktu yang diminta, atau jika sesi dengan PlaybackMode of LIVE diminta untuk aliran yang tidak memiliki fragmen dalam 30 detik terakhir.

Kode Status HTTP: 404

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: