Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
StartEdgeConfigurationUpdate
API asinkron yang memperbarui konfigurasi tepi aliran yang ada. Kinesis Video Stream akan menyinkronkan konfigurasi tepi aliran dengan komponen Edge Agent IoT IoT yang berjalan pada Perangkat Hub IoT, disiapkan di premis Anda. Waktu untuk menyinkronkan dapat bervariasi dan tergantung pada konektivitas Perangkat Hub. Ini SyncStatus
akan diperbarui saat konfigurasi tepi diakui, dan disinkronkan dengan Agen Edge.
Jika API ini dipanggil untuk pertama kalinya, konfigurasi edge baru akan dibuat untuk streaming, dan status sinkronisasi akan disetel keSYNCING
. Anda harus menunggu status sinkronisasi mencapai status terminal seperti:IN_SYNC
, atauSYNC_FAILED
, sebelum menggunakan API ini lagi. Jika Anda menjalankan API ini selama proses sinkronisasi, a ResourceInUseException
akan dilemparkan. Konektivitas konfigurasi tepi aliran dan Agen Edge akan dicoba lagi selama 15 menit. Setelah 15 menit, status akan beralih ke SYNC_FAILED
negara bagian.
Untuk memindahkan konfigurasi tepi dari satu perangkat ke perangkat lainnya, gunakan DeleteEdgeConfiguration untuk menghapus konfigurasi tepi saat ini. Anda kemudian dapat memanggil StartEdgeConfigurationUpdate dengan ARN Perangkat Hub yang diperbarui.
catatan
API ini tidak tersedia di wilayah AWS Afrika (Cape Town), af-south-1.
Minta Sintaks
POST /startEdgeConfigurationUpdate HTTP/1.1
Content-type: application/json
{
"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
"
}
}
},
"StreamARN": "string
",
"StreamName": "string
"
}
Parameter Permintaan URI
Permintaan tidak menggunakan parameter URI apa pun.
Isi Permintaan
Permintaan menerima data berikut dalam format JSON.
- EdgeConfig
-
Detail konfigurasi tepi diperlukan untuk menjalankan proses pembaruan.
Tipe: Objek EdgeConfig
Wajib: Ya
- 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,
"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
- 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 sinkronisasi saat ini dari konfigurasi tepi aliran. Saat Anda menjalankan API ini, status sinkronisasi akan disetel ke
SYNCING
status. GunakanDescribeEdgeConfiguration
API untuk mendapatkan status terbaru dari konfigurasi edge.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
- NoDataRetentionException
-
Retensi data Stream dalam jam sama dengan nol.
Kode Status HTTP: 400
- ResourceInUseException
-
Ketika input
StreamARN
atauChannelARN
in sudahCLOUD_STORAGE_MODE
dipetakan ke sumber Kinesis Video Stream yang berbeda, atau jikaStreamARN
inputChannelARN
yang disediakan atau tidak dalam status Aktif, coba salah satu dari berikut ini:-
DescribeMediaStorageConfiguration
API untuk menentukan saluran aliran yang diberikan dipetakan. -
DescribeMappedResourceConfiguration
API untuk menentukan saluran tempat aliran yang diberikan dipetakan. -
DescribeSignalingChannel
APIDescribeStream
atau untuk menentukan status sumber daya.
Kode Status HTTP: 400
-
- ResourceNotFoundException
-
Amazon Kinesis Video Streams tidak dapat menemukan 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: