調用AddCdnDomain添加加速域名。
接口說明
- 添加域名之前，您需要先開通 CDN 服務。具體操作，請參見開通 CDN 服務。
- 加速域名必須已成功備案。
- 每次只能添加一個加速域名，每個用戶最多可以添加 50 個域名。
- 源站內容如果不在阿里云平臺上，需進行審核，審核工作會在下一個工作日前完成。
- 單個用戶的調用頻率：30 次/秒。
注意事項
- 通過接口添加了域名之后，將會有 3～5 分鐘的域名生效時間，在這段時間內請不要添加任何配置，待域名狀態處于 online 以后再進行下一步的配置。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cdn:AddCdnDomain | create | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CdnType | string | 是 | 加速域名的業務類型。取值：
枚舉值：
| web |
| DomainName | string | 是 | 需要接入 CDN 的加速域名。 支持泛域名，以英文句號（.）開頭，例如.example.com。 | .example.com |
| ResourceGroupId | string | 否 | 資源組 ID。 不傳該參數時，系統自動補全為默認資源組 ID。 | rg-acfmyuji4b6r4** |
| Sources | string | 是 | 回源地址列表。 | [ { "content": "192.0.2.0", "type": "ipaddr", "priority": "20", "port": 80, "weight": "15" } ] |
| CheckUrl | string | 否 | 健康檢測 URL。 | www.example.com/test.html |
| Scope | string | 否 | 加速區域。取值：
| domestic |
| TopLevelDomain | string | 否 | 頂級接入域。 | example.com |
| Tag | array<object> | 否 | 標簽信息列表。最大可填入 20 個標簽信息。 | |
| object | 否 | |||
| Key | string | 否 | 標簽鍵。 | env |
| Value | string | 否 | 標簽值。 | value |
Sources 參數的各字段含義如下表所示。
| 參數 | 類型 | 是否必選 | 描述 |
|---|---|---|---|
| type | String | 是 | 源站類型。取值： ipaddr：IP 源站。 domain：域名源站。 oss：OSS Bucket 為源站。 fc_domain：函數計算為源站。 |
| content | String | 是 | 回源地址，可以是 IP 或域名。 |
| port | Integer | 否 | 端口。 您可以指定 443 或 80 端口，也可以自定義端口，默認值為 80 端口。443 端口支持 HTTPS 協議回源。 |
| priority | String | 否 | 源站地址對應的優先級。 支持 20 和 30，默認值為 20。20 是主源，30 是備源。 |
| weight | String | 否 | 回源權重，取值范圍為 100 以內，默認值為 10。 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidDomainName.Malformed | Specified DomainName is malformed. | 域名格式錯誤或批量新增不支持泛域名。 |
| 400 | MissingParameter | The input parameter cdnType that is mandatory for processing this request is not supplied. | 參數cdnType為必填。 |
| 400 | InvalidCdnType.Malformed | Specified CdnType is malformed. | 參數CdnType不支持該參數值， 取值：web：圖片及小文件分發；download：大文件下載加速；video：視音頻點播加速； |
| 400 | InvalidSources.Malformed | Specified Sources is malformed. | 源站地址格式錯誤。 |
| 400 | MissingParameter | Origin server information is not complete, please fill in again. | - |
| 400 | MissingParameter | The input parameter sourceType that is mandatory for processing this request is not supplied. | 參數sourceType為必填。 |
| 400 | InvalidSourceType.Malformed | Specified CdnType is malformed. | CdnType格式錯誤。 |
| 400 | InvalidSource.Priority.Malformed | The specified Source Priority is invalid. | - |
| 400 | InvalidTypeAndContent.MissMatch | The specified source type does not match the specified source content. | - |
| 400 | InvalidScope.Malformed | Specified Scope is malformed. | Scope格式錯誤。 |
| 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 has not bind aoneId, can not add domain. | 您的帳戶沒有綁定aoneId，不能添加域名。 |
| 400 | CheckSourceHealthFailed | sources ip or source domain check health failed,please input right source. | 源IP或源域檢查錯誤, 請輸入正確的源。 |
| 400 | ExtensiveAndAllBothExist | Extensive domain and the domain begins with all. can not exist at the same time. | 泛域名與all.開頭域名不能同時存在。 |
| 400 | CdnTypeNotSupportExtensiveDomain | Extensive domain not supported for this cdn type. | 泛域名不支持該業務類型，目前泛域名只支持圖片小文件加速，大文件下載加速，視頻點播加速，請知悉。 |
| 400 | ExtensiveAndSpecificDomainConflict | The number of wildcard domain names exceeds the limit. | - |
| 400 | InvalidResourceGroupId.Malformed | Specified ResourceGroupId is malformed. | 參數ResourceGroupId格式錯誤。 |
| 400 | DomainReserved | The root domain of your domain is reserved by another account. Submit a ticket to contact customer support. | - |
| 400 | InvalidDomainNameLevel | Domain name suffixed with alicdn.com only support third level. | alicdn.com（針對泛域名）最多支持三級域名。 |
| 400 | InvalidTopLevelDomain.Malformed | Specified TopLevelDomain is malformed. | 參數TopLevelDomain錯誤。 |
| 400 | TopLevelDomain.NotFound | TopLevelDomain is not exist. | TopLevelDomain不存在。 |
| 400 | EntityNotExists.ResourceGroup | The resource group does not exist. | 資源組不存在。 |
| 400 | EntityNotExist.ResourceGroup | The resource group does not exist. | 該資源組不存在。 |
| 400 | InvalidStatus.ResourceGroup | It is not 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 | Abs.CheckUrl.Malformed | The CheckUrl you provided is malformed. | - |
| 400 | RecordCheckNotAvailable | The ICP filing interface is unavailable. Please try again later. | - |
| 400 | IcpBlack | The domain is on the ICP blacklist. | - |
| 400 | IspBlack | The domain is on the ISP blacklist. | - |
| 400 | DomainOwnerVerifyFail | Owner verification of the root domain failed. | 當您首次將新域名添加至阿里云CDN時，需按要求做域名歸屬權驗證，當您按要求配置DNS解析或文件驗證后，才能正常成功添加域名。 |
| 400 | TopLevelDomain.Mismatch | The specified TopLevelDomain does not match webSiteType. | 頂級接入域和域名類型不匹配。 |
| 400 | DomainInBlacklist | The domain is in the blacklist. | 該域名在黑名單中。 |
| 400 | InvalidTagKey | The specified TagKey is invalid. | 參數TagKey無效。 |
| 400 | InvalidTagValue | The specified TagValue is invalid. | - |
| 400 | InvalidTagKey.Repeated | The specified TagKey is duplicated. | - |
| 400 | InvalidTag | The specified Tag is Invalid. | - |
| 400 | InvalidTagKey.OverLimit | The number of Tag can not over limit 20. | - |
| 400 | SourceInBlacklist | Source is in the blacklist. | 源站在黑名單中。 |
| 400 | InvalidTagKey | The key should not be null, start with "acs:" or "aliyun", contain "http://" or "https://" or have special symbols:.!@#$%?/^&*)(+={}[]",'<>~·`?;. | - |
| 400 | InvalidTagValue | The tag value cannot contain these special symbols:http://, https:// | - |
| 400 | ReservedTagKey | The tag key is used internally as a reserved field and is not allowed to be used. | 該標簽鍵被用作內部保留字段，不允許使用。 |
| 400 | DomainOverLimit | The maximum number of domains is exceeded. | 域名數量超過上限 |
| 400 | DomainInRiskList | The domain you added may be at risk. If you have any questions, please submit a ticket. | 您所添加的域名可能存在風險，如有任何疑問，請提交工單。 |
| 400 | RegionNoResource | Resource allocation failed. Please submit a work order to contact customer service. | 資源分配失敗，請提交工單聯系客服。 |
| 403 | AccountException | Account exception. Please open ticket to make an appeal. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-11-15 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-09-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-12-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-08-08 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-06-27 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |