調用該接口添加直播域名,一次只能提交一個域名。
接口說明
-
添加直播域名之前,必須先開通視頻直播服務。具體操作請參見開通服務。
-
添加新的域名時,必須先進行驗證,再調用本接口添加域名。您可以選擇 DNS 解析驗證或文件驗證。請參見驗證域名歸屬權。
-
使用視頻直播需要進行推流和播流,您需要分別添加推流域名和播流域名,一次只能提交一個域名。
-
完成添加域名操作后,還需要對添加的域名進行 CNAME 解析,請參見配置 CNAME 域名解析。
-
在添加推流域名和播流域名后,您需要關聯域名,才能使用視頻直播服務,具體操作請參見關聯域名。
注意 從 2019 年 2 月 19 日起,通過 AddLiveDomain 添加的域名不支持中心推流的方式,通過 CDN API 添加的新域名同樣不支持中心推流。請使用邊緣推流添加一個推流域名(調用 AddLiveDomain,業務類型為 liveEdge),一個播流域名(調用 AddLiveDomain,業務類型為 liveVideo),并做關聯(調用 AddLiveDomainMapping ),2019 年 2 月 19 日之前添加的域名不受影響。
QPS 限制
本接口的單用戶 QPS 限制為 30 次/秒。超過限制,API 調用會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
live:AddLiveDomain | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
LiveDomainType | string | 是 | 域名業務類型。取值:
| liveVideo |
DomainName | string | 是 | 需要接入直播的推流域名或播流域名。支持泛域名,以英文句號(.)開頭。 | example.aliyundoc.com |
Region | string | 是 | 直播域名單元化信息。取值:
說明
Region(直播域名單元化信息)與 Scope(加速區域)之間不存在相互限制。
| cn-beijing |
CheckUrl | string | 否 | 健康檢測 URL。 | http://demo.aliyundoc.com/status.html |
Scope | string | 否 | 加速區域。國際用戶、中國站 L3 及以上用戶設置有效。取值:
| domestic |
TopLevelDomain | string | 否 | 頂級接入域。 | learn.aliyundoc.com |
ResourceGroupId | string | 否 | 資源組 ID。關于資源組的更多信息,請參見什么是資源組。 | rg-aekzw****** |
Tag | array<object> | 否 | 標簽列表。 | |
object | 否 | 標簽列表。 | ||
Key | string | 否 | 標簽健。 | TestKey |
Value | string | 否 | 標簽值。 | TestValue |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidDomainName.Malformed | Specified DomainName is malformed. | - |
400 | InvalidRegion.Malformed | Specified Region is malformed. | 指定的區域無效。 |
400 | InvalidSource.Content.Malformed | Specified source content is malformed. | - |
400 | InvalidTypeContent.Mismatch | Specified source type does not math the specified source content. | - |
400 | MissingSource.Content | Specified source content is mandatory for this action. | - |
400 | MissingSource.Type | Specified source type is mandatory for this action. | - |
400 | InvalidSource.Type.Malformed | Specified source type is malformed. | - |
400 | InvalidSource.Priority.Malformed | Specified source priority is malformed. | - |
400 | InvalidScope.Malformed | Specified Scope is malformed. | - |
400 | SourceIp.Exceed | The Certificate you provided is malformed! | - |
400 | InvalidCertificate | The Certificate you provided is malformed! | - |
400 | InvalidCertificate.TooLong | The Certificate you provided is over the max length! | - |
400 | InnerAddDomainDenied | Your account haven't bind aoneId, can not add domain. | - |
400 | CheckSourceHealthFailed | sources ip or source domain check health failed,please input right source. | - |
400 | ExtensiveAndAllBothExist | Extensive domain and the domain begins with 'all.' can not exist at the same time. | - |
400 | CdnTypeNotSupportExtensiveDomain | Extensive domain not supported for this cdn type. | - |
400 | ExtensiveAndSpecificDomainConflict | Extensive domain and corresponding specific domain are mutually exclusive. | 泛域名與對應的精確域名沖突 |
400 | InvalidDomainNameLevel | Domain name suffixed with alicdn.com only support third level. | - |
400 | TopLevelDomain.NotFound | TopLevelDomain is not exist. | - |
400 | EntityNotExists.ResourceGroup | The resource group does not exist. | - |
400 | InvalidStatus.ResourceGroup | It's now allowed to do this operation because of the current status of resource-group. | - |
400 | NotInternationRealIdentity | You need to do real name authentication when you use Chinese mainland resources. | 你需要使用真正的授權身份來訪問中國大陸的資源 |
400 | RecordCheckNotAvailable | Please try again later. | - |
400 | IcpBlack | The domain is on the ICP blacklist. | - |
400 | IspBlack | The domain is on the ISP blacklist. | - |
400 | DomainNotRecordedAliyun | The domain not access Ali Cloud for the record please access. | - |
400 | Abs.CheckUrl.Malformed | The CheckUrl you provided is malformed! | - |
400 | DomainOwnerVerifyFail | Owner verification of the root domain failed. | - |
400 | TopLevelDomain.Mismatch | The specified TopLevelDomain does not match webSiteType. | - |
400 | InvalidResourceGroupId.Malformed | Specified ResourceGroupId is malformed. | - |
400 | DomainReserved | The root domain of your domain is reserved by another account. | 此域名的根域名已添加到其他賬號。 |
400 | ExceedLimit | The number of domains has exceeded the limit. | 擁有的域名數量已經超過上限。 |
400 | LockFail | Domain has been occupied. | - |
403 | AccountException | Account exception. Please open ticket to make an appeal. | - |
403 | EntityNotExist.ResourceGroup | The resource group does not exist. | 資源組不存在。 |
404 | InvalidUser | The user's account is invalid. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-24 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-09-27 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-09-25 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-05-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |