本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# DescribeSignalingChannel
<a name="API_DescribeSignalingChannel"></a>

傳回有關訊號頻道的最新資訊。您必須指定要描述之頻道的名稱或 Amazon Resource Name (ARN)。

## 請求語法
<a name="API_DescribeSignalingChannel_RequestSyntax"></a>

```
POST /describeSignalingChannel HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "{{string}}",
   "ChannelName": "{{string}}"
}
```

## URI 請求參數
<a name="API_DescribeSignalingChannel_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_DescribeSignalingChannel_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ChannelARN](#API_DescribeSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-DescribeSignalingChannel-request-ChannelARN"></a>
您要描述之訊號頻道的 ARN。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [ChannelName](#API_DescribeSignalingChannel_RequestSyntax) **   <a name="KinesisVideo-DescribeSignalingChannel-request-ChannelName"></a>
您要描述的訊號頻道名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_DescribeSignalingChannel_ResponseSyntax"></a>

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

{
   "ChannelInfo": { 
      "ChannelARN": "string",
      "ChannelName": "string",
      "ChannelStatus": "string",
      "ChannelType": "string",
      "CreationTime": number,
      "SingleMasterConfiguration": { 
         "MessageTtlSeconds": number
      },
      "Version": "string"
   }
}
```

## 回應元素
<a name="API_DescribeSignalingChannel_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ChannelInfo](#API_DescribeSignalingChannel_ResponseSyntax) **   <a name="KinesisVideo-DescribeSignalingChannel-response-ChannelInfo"></a>
封裝指定訊號頻道中繼資料和屬性的結構。  
類型：[ChannelInfo](API_ChannelInfo.md) 物件

## 錯誤
<a name="API_DescribeSignalingChannel_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeSignalingChannel_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 C\+\+ 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeSignalingChannel) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeSignalingChannel)