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

# GetIceServerConfig
<a name="API_signaling_GetIceServerConfig"></a>

 **Catatan:** Sebelum menggunakan API ini, Anda harus memanggil `GetSignalingChannelEndpoint` API untuk meminta titik akhir HTTPS. Anda kemudian menentukan titik akhir dan wilayah dalam permintaan `GetIceServerConfig` API Anda.

Mendapatkan informasi konfigurasi server Interactive Connectivity Establishment (ICE) URIs, termasuk, nama pengguna, dan kata sandi yang dapat digunakan untuk mengonfigurasi koneksi WebRTC. Komponen ICE menggunakan informasi konfigurasi ini untuk mengatur koneksi WebRTC, termasuk mengautentikasi dengan Traversal Using Relays around NAT (TURN) relay server. 

TURN adalah protokol yang digunakan untuk meningkatkan konektivitas peer-to-peer aplikasi. Dengan menyediakan layanan relai berbasis cloud, TURN memastikan bahwa koneksi dapat dibuat bahkan ketika satu atau lebih rekan tidak mampu melakukan koneksi langsung. peer-to-peer Untuk informasi selengkapnya, lihat [REST API Untuk Akses Untuk Mengubah Layanan](https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00).

 Anda dapat menjalankan API ini untuk membuat mekanisme fallback jika salah satu rekan tidak dapat membuat peer-to-peer koneksi langsung melalui saluran pensinyalan. Anda harus menentukan Nama Sumber Daya Amazon (ARN) saluran pensinyalan Anda untuk menjalankan API ini.

## Minta Sintaks
<a name="API_signaling_GetIceServerConfig_RequestSyntax"></a>

```
POST /v1/get-ice-server-config HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "{{string}}",
   "ClientId": "{{string}}",
   "Service": "{{string}}",
   "Username": "{{string}}"
}
```

## Parameter Permintaan URI
<a name="API_signaling_GetIceServerConfig_RequestParameters"></a>

Permintaan tidak menggunakan parameter URI apa pun.

## Isi Permintaan
<a name="API_signaling_GetIceServerConfig_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [ChannelARN](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ChannelARN"></a>
ARN dari saluran pensinyalan yang akan digunakan untuk peer-to-peer koneksi antara rekan yang dikonfigurasi.   
Tipe: 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

 ** [ClientId](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ClientId"></a>
Pengidentifikasi unik untuk penampil. Harus unik di dalam saluran pensinyalan.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z0-9_.-]+`   
Wajib: Tidak

 ** [Service](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Service"></a>
Menentukan layanan yang diinginkan. Saat ini, `TURN` adalah satu-satunya nilai yang valid.  
Tipe: String  
Nilai yang Valid: `TURN`   
Wajib: Tidak

 ** [Username](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Username"></a>
ID pengguna opsional yang akan dikaitkan dengan kredensialnya.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z0-9_.-]+`   
Diperlukan: Tidak

## Sintaksis Respons
<a name="API_signaling_GetIceServerConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IceServerList": [ 
      { 
         "Password": "string",
         "Ttl": number,
         "Uris": [ "string" ],
         "Username": "string"
      }
   ]
}
```

## Elemen Respons
<a name="API_signaling_GetIceServerConfig_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [IceServerList](#API_signaling_GetIceServerConfig_ResponseSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-response-IceServerList"></a>
Daftar objek informasi server ICE.  
Tipe: Array objek [IceServer](API_signaling_IceServer.md)

## Kesalahan
<a name="API_signaling_GetIceServerConfig_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Jenis Kesalahan Umum](CommonErrors.md).

 ** ClientLimitExceededException **   
Permintaan Anda dibatasi 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

 ** InvalidClientException **   
Klien yang ditentukan tidak valid.  
Kode Status HTTP: 400

 ** NotAuthorizedException **   
Penelepon tidak berwenang untuk melakukan operasi ini.  
Kode Status HTTP: 401

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak ditemukan.  
Kode Status HTTP: 404

 ** SessionExpiredException **   
Jika sesi klien kedaluwarsa. Setelah klien terhubung, sesi berlaku selama 45 menit. Klien harus menyambung kembali ke saluran untuk melanjutkan pengiriman/menerima pesan.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_signaling_GetIceServerConfig_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig)