DescribeEdgeConfiguration - 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.

DescribeEdgeConfiguration

Menjelaskan konfigurasi tepi aliran yang disetel menggunakan StartEdgeConfigurationUpdate API dan status terbaru dari pekerjaan perekam dan pengunggah agen edge. Gunakan API ini untuk mendapatkan status konfigurasi untuk menentukan apakah konfigurasi sinkron dengan Edge Agent. Gunakan API ini untuk mengevaluasi kesehatan Agen Edge.

catatan

API ini tidak tersedia di wilayah AWS Afrika (Cape Town), af-south-1.

Minta Sintaks

POST /describeEdgeConfiguration HTTP/1.1
Content-type: application/json

{
   "StreamARN": "string",
   "StreamName": "string"
}

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

StreamARN

Nama Sumber Daya Amazon (ARN) dari aliran. Tentukan salah satu StreamName atauStreamARN.

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 yang konfigurasi tepinya ingin Anda perbarui. Tentukan salah satu StreamName atauStreamARN.

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

{
   "CreationTime": number,
   "EdgeAgentStatus": { 
      "LastRecorderStatus": { 
         "JobStatusDetails": "string",
         "LastCollectedTime": number,
         "LastUpdatedTime": number,
         "RecorderStatus": "string"
      },
      "LastUploaderStatus": { 
         "JobStatusDetails": "string",
         "LastCollectedTime": number,
         "LastUpdatedTime": number,
         "UploaderStatus": "string"
      }
   },
   "EdgeConfig": { 
      "DeletionConfig": { 
         "DeleteAfterUpload": boolean,
         "EdgeRetentionInHours": number,
         "LocalSizeConfig": { 
            "MaxLocalMediaSizeInMB": number,
            "StrategyOnFullSize": "string"
         }
      },
      "HubDeviceArn": "string",
      "RecorderConfig": { 
         "MediaSourceConfig": { 
            "MediaUriSecretArn": "string",
            "MediaUriType": "string"
         },
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      },
      "UploaderConfig": { 
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      }
   },
   "FailedStatusDetails": "string",
   "LastUpdatedTime": number,
   "StreamARN": "string",
   "StreamName": "string",
   "SyncStatus": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

CreationTime

Stempel waktu di mana konfigurasi tepi aliran pertama kali dibuat.

Tipe: Timestamp

EdgeAgentStatus

Objek yang berisi detail status terbaru untuk perekam dan pekerjaan pengunggah agen edge. Gunakan informasi ini untuk menentukan kesehatan agen edge saat ini.

Tipe: Objek EdgeAgentStatus

EdgeConfig

Deskripsi konfigurasi tepi aliran yang akan digunakan untuk menyinkronkan dengan komponen Edge Agent IoT Greengrass. Komponen Edge Agent akan berjalan pada pengaturan Perangkat IoT Hub di premis Anda.

Tipe: Objek EdgeConfig

FailedStatusDetails

Deskripsi status kegagalan yang dihasilkan.

Jenis: String

LastUpdatedTime

Stempel waktu di mana konfigurasi tepi aliran terakhir diperbarui.

Tipe: Timestamp

StreamARN

Nama Sumber Daya Amazon (ARN) dari aliran.

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]+

StreamName

Nama aliran dari mana konfigurasi tepi diperbarui.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.

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

SyncStatus

Status terbaru dari pembaruan konfigurasi tepi.

Jenis: String

Nilai yang Valid: SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED

Kesalahan

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

AccessDeniedException

Anda tidak memiliki izin yang diperlukan untuk melakukan operasi ini.

Kode Status HTTP: 401

ClientLimitExceededException

Kinesis Video Streams telah membatasi permintaan karena Anda telah melampaui batas panggilan klien yang diizinkan. Coba buat panggilan nanti.

Kode Status HTTP: 400

InvalidArgumentException

Nilai untuk parameter input ini tidak valid.

Kode Status HTTP: 400

ResourceNotFoundException

Amazon Kinesis Video Streams tidak dapat menemukan aliran yang Anda tentukan.

Kode Status HTTP: 404

StreamEdgeConfigurationNotFoundException

Pengecualian yang dirender saat Amazon Kinesis Video Stream tidak dapat menemukan konfigurasi tepi aliran yang Anda tentukan.

Kode Status HTTP: 404

Lihat Juga

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