調用CreateCaster建立導播台。
介面說明
您已開通雲導播服務再調用本介面建立導播台。開通指引,請參見開通服務。 本介面目前支援的導播台規格類型為通用型和新播單型(輪播台)。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:CreateCaster |
create |
*Caster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-beijing |
| CasterName |
string |
否 |
導播台名稱。 |
liveCaster**** |
| ClientToken |
string |
是 |
使用者產生的請求 token。用於保證請求的等冪性。 該參數值可自訂,但是要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字元。 |
53200b81-b761-4c10-842a-a0726d97**** |
| NormType |
integer |
是 |
導播台規格類型。取值:
|
1 |
| ChargeType |
string |
是 |
付費方式。 目前只支援 PostPaid。取值:
|
PostPaid |
| PurchaseTime |
string |
否 |
導播台購買時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
當 ChargeType 為 PrePaid 時,此參數才可設定。 |
2017-08-20T12:10:10Z |
| ExpireTime |
string |
否 |
導播台到期時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
當 ChargeType 為 PrePaid 時,此參數才可設定。 |
2017-08-22T12:10:10Z |
| CasterTemplate |
string |
否 |
導播台預設解析度。採用預付費方式時,取值:
說明
後付費情境下,需要設定解析度,請調用 SetCasterConfig 介面進行操作。 |
lp_sd |
| ResourceGroupId |
string |
否 |
資源群組 ID。關於資源群組的更多資訊,請參見什麼是資源群組。 |
rg-aekzw****** |
| Tag |
array<object> |
否 |
標籤列表。 |
|
|
object |
否 |
標籤列表。 |
||
| Key |
string |
否 |
標籤健。 |
TestKey |
| Value |
string |
否 |
標籤值。 |
TestValue |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| CasterId |
string |
導播台 ID。可作為查詢導播台流地址、啟動導播台、添加導播台視頻資源、添加導播檯布局、查詢導播檯布局列表、添加導播台組件和添加導播台節目單的請求參數。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| RequestId |
string |
請求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F**** |
樣本
正常返回樣本
JSON格式
{
"CasterId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.PurchaseTime | %s | |
| 400 | InvalidParameter.ExpireTime | %s | |
| 400 | MissingParameter | %s | |
| 400 | InvalidChargeType.Malformed | %s | |
| 400 | InvalidChargeType.PostSupport | %s | |
| 400 | InvalidCasterTemplate.Malformed | %s | |
| 400 | InvalidParameter.Malformed | %s | |
| 400 | InvalidParameter.ChargeType | %s | |
| 400 | InvalidPeriod.Malformed | %s | |
| 400 | InvalidUserId.Malformed | %s | |
| 400 | InvalidClientToken.Malformed | %s | |
| 400 | IncorrectCasterStatus | %s | |
| 401 | CasterNumberExceed | %s | |
| 403 | PermissionDenied | %s | |
| 404 | InvalidParameter.NormType | %s | |
| 404 | InvalidConfiguration.NotFound | %s | |
| 408 | CreateCaster.Timeout | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。