GetSignalingChannelEndpoint

Menyediakan titik akhir untuk saluran pensinyalan yang ditentukan untuk mengirim dan menerima pesan. API ini menggunakan parameter SingleMasterChannelEndpointConfiguration input, yang terdiri dari Protocols dan Role properti.

Protocolsdigunakan untuk menentukan mekanisme komunikasi. Misalnya, jika Anda menetapkan WSS sebagai protokol, API ini menghasilkan titik akhir websocket yang aman. Jika Anda menentukan HTTPS sebagai protokol, API ini menghasilkan titik akhir HTTPS. Jika Anda menentukan WEBRTC sebagai protokol, tetapi saluran pensinyalan tidak dikonfigurasi untuk konsumsi, Anda akan menerima kesalahan. InvalidArgumentException

Rolemenentukan izin pesan. MASTERPeran menghasilkan API ini menghasilkan titik akhir yang dapat digunakan klien untuk berkomunikasi dengan pemirsa mana pun di saluran. VIEWERPeran menghasilkan API ini menghasilkan titik akhir yang dapat digunakan klien untuk berkomunikasi hanya dengan MASTER file.

Minta Sintaks

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

{
   "ChannelARN": "string",
   "SingleMasterChannelEndpointConfiguration": { 
      "Protocols": [ "string" ],
      "Role": "string"
   }
}

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

ChannelARN

Nama Sumber Daya Amazon (ARN) dari saluran pensinyalan yang ingin Anda dapatkan titik akhir.

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: Ya

SingleMasterChannelEndpointConfiguration

Struktur yang berisi konfigurasi titik akhir untuk jenis SINGLE_MASTER saluran.

Tipe: Objek SingleMasterChannelEndpointConfiguration

Wajib: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "ResourceEndpointList": [ 
      { 
         "Protocol": "string",
         "ResourceEndpoint": "string"
      }
   ]
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

ResourceEndpointList

Daftar titik akhir untuk saluran pensinyalan yang ditentukan.

Tipe: Array objek ResourceEndpointListItem

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

ResourceInUseException

Ketika input StreamARN atau ChannelARN in sudah CLOUD_STORAGE_MODE dipetakan ke sumber Kinesis Video Stream yang berbeda, atau jika StreamARN input ChannelARN yang disediakan atau tidak dalam status Aktif, coba salah satu dari berikut ini:

1. DescribeMediaStorageConfigurationAPI untuk menentukan saluran aliran yang diberikan dipetakan.

2. DescribeMappedResourceConfigurationAPI untuk menentukan saluran tempat aliran yang diberikan dipetakan.

3. DescribeSignalingChannelAPI DescribeStream 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:

• AWS Antarmuka Baris Perintah

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK untuk V3 JavaScript

• AWS SDK for PHP V3

• AWS SDK untuk Python

• AWS SDK for Ruby V3