阿里云內(nèi)容分發(fā)服務(wù)API參考手冊(cè).pdf
下載文檔
上傳人:職z****i
編號(hào):1314125
2025-03-04
37頁(yè)
1.21MB
1、 阿里云阿里云內(nèi)容分發(fā)內(nèi)容分發(fā)服務(wù)服務(wù) Aliyun Aliyun Content Delivery NetworkContent Delivery Network APIAPI 參考手冊(cè)參考手冊(cè) (APIAPI 版本版本 v v1 1.6 6 2012014 4-1 10 0-0101)目錄 1 簡(jiǎn)介.4 1.1 術(shù)語(yǔ)表.4 1.2 業(yè)務(wù)限制資源規(guī)格限制說(shuō)明.4 2 調(diào)用方式.4 2.1 請(qǐng)求結(jié)構(gòu).4 2.1.1 服務(wù)地址.4 2.1.2 通信協(xié)議.4 2.1.3 請(qǐng)求方法.4 2.1.4 請(qǐng)求參數(shù).4 2.1.5 字符編碼.5 2.2 公共參數(shù).5 2.2.1 公共請(qǐng)求參數(shù).5 2.2.22、 公共返回參數(shù).5 2.3 返回結(jié)果.6 2.3.1 成功結(jié)果.6 2.3.2 錯(cuò)誤結(jié)果.7 2.4 簽名機(jī)制.7 3 接口說(shuō)明.9 3.1 OpenCdnService.9 3.2 DescribeCdnService.11 3.3 ModifyCdnService.12 3.4 DescribeUserDomains.14 3.5 RefreshObjectCaches.17 3.6 DescribeRefreshTasks.19 3.7 DescribeCdnMonitorData.25 4 數(shù)據(jù)類型.30 MonitorDataItem.30 描述.30 節(jié)點(diǎn)名.30 子節(jié)點(diǎn).30 D3、omain 數(shù)據(jù)類型.30 描述.30 節(jié)點(diǎn)名.30 子節(jié)點(diǎn).31 TaskItem 數(shù)據(jù)類型.31 描述.31 節(jié)點(diǎn)名.31 子節(jié)點(diǎn).31 5 附錄.32 5.1 錯(cuò)誤代碼表.32 5.1.1 客戶端錯(cuò)誤.32 5.1.2 服務(wù)器端錯(cuò)誤.33 5.2 如何調(diào)用接口.34 5.2.1 請(qǐng)求組成.34 5.2.2 調(diào)用示例.34 5.3 如何保證冪等性.36 5.4 欠費(fèi)狀態(tài)下的 API 行為.37 5.4.1 賬戶欠費(fèi)時(shí).37 1 簡(jiǎn)介簡(jiǎn)介 歡迎使用阿里云彈性計(jì)算服務(wù)CDN(Content Delivery Network)。用戶可以使用本文檔介紹的API對(duì)CDN服務(wù)進(jìn)行相關(guān)操作。請(qǐng)確保在使用4、這些接口前,已充分了解請(qǐng)確保在使用這些接口前,已充分了解CDN產(chǎn)品說(shuō)明、使用協(xié)議和收費(fèi)方式。產(chǎn)品說(shuō)明、使用協(xié)議和收費(fèi)方式。1.1 術(shù)語(yǔ)表術(shù)語(yǔ)表 術(shù)語(yǔ)術(shù)語(yǔ) 全全 稱稱 中文中文 說(shuō)說(shuō) 明明 1.2 業(yè)務(wù)限制資源規(guī)格限制說(shuō)明業(yè)務(wù)限制資源規(guī)格限制說(shuō)明 見附表 2 調(diào)用方式調(diào)用方式 對(duì)CDN API接口調(diào)用是通過(guò)向CDN API的服務(wù)端地址發(fā)送HTTP GET請(qǐng)求,并按照接口說(shuō)明在請(qǐng)求中加入相應(yīng)請(qǐng)求參數(shù)來(lái)完成的;根據(jù)請(qǐng)求的處理情況,系統(tǒng)會(huì)返回處理結(jié)果。2.1 請(qǐng)求結(jié)構(gòu)請(qǐng)求結(jié)構(gòu) 2.1.1 服務(wù)地址服務(wù)地址 CDN API 的服務(wù)接入地址為: 2.1.2 通信協(xié)議通信協(xié)議 支持通過(guò)HTTP或HTTPS通5、道進(jìn)行請(qǐng)求通信。為了獲得更高的安全性,推薦您使用HTTPS通道發(fā)送請(qǐng)求。2.1.3 請(qǐng)求方法請(qǐng)求方法 支持 HTTP GET 方法發(fā)送請(qǐng)求,這種方式下請(qǐng)求參數(shù)需要包含在請(qǐng)求的 URL 中。2.1.4 請(qǐng)求參數(shù)請(qǐng)求參數(shù) 每個(gè)請(qǐng)求都需要指定要執(zhí)行的操作,即Action參數(shù)(例如CreateCDNServer),以及每個(gè)操作都需要包含的公共請(qǐng)求參數(shù)和指定操作所特有的請(qǐng)求參數(shù)。2.1.5 字符字符編碼編碼 請(qǐng)求及返回結(jié)果都使用 UTF-8 字符集進(jìn)行編碼。2.2 公共參數(shù)公共參數(shù) 2.2.1 公共請(qǐng)求參數(shù)公共請(qǐng)求參數(shù) 公共請(qǐng)求參數(shù)是指每個(gè)接口都需要使用到的請(qǐng)求參數(shù)。名稱名稱 類型類型 是否必須是否必須6、 描述描述 Format String 否 返回值的類型,支持 JSON 與 XML。默認(rèn)為 XML Version String 是 API 版本號(hào),為日期形式:YYYY-MM-DD,本版本對(duì)應(yīng)為 2014-11-11 AccessKeyId String 是 阿里云頒發(fā)給用戶的訪問(wèn)服務(wù)所用的密鑰 ID Signature String 是 簽名結(jié)果串,關(guān)于簽名的計(jì)算方法,請(qǐng)參見簽名機(jī)制。SignatureMethod String 是 簽名方式,目前支持 HMAC-SHA1 Timestamp String 是 請(qǐng)求的時(shí)間戳。日期格式按照 ISO8601 標(biāo)準(zhǔn)表示,并需要使用 UTC 時(shí)間7、。格式為:YYYY-MM-DDThh:mm:ssZ 例如,2014-11-11T12:00:00Z(為北京時(shí)間 2014年 11 月 11 日 20 點(diǎn) 0 分 0 秒)SignatureVersion String 是 簽名算法版本,目前版本是 1.0 SignatureNonce String 是 唯一隨機(jī)數(shù),用于防止網(wǎng)絡(luò)重放攻擊。用戶在不同請(qǐng)求間要使用不同的隨機(jī)數(shù)值 OwnerId String 是 資源所有者的阿里云賬戶 ID,即用戶的阿里云賬戶 id_kp(可以通過(guò)賬號(hào)系統(tǒng) API 獲得)。該參數(shù)和“OwnerAccount”不能同時(shí)出現(xiàn)。OwnerAccount String 是 8、資源所有者的阿里云賬戶,即登錄用戶名。該參數(shù)和“OwnerId”不能同時(shí)出現(xiàn)。請(qǐng)求請(qǐng)求示例:示例:https:/ 2.2.2 公共返回參數(shù)公共返回參數(shù) 用戶發(fā)送的每次接口調(diào)用請(qǐng)求,無(wú)論成功與否,系統(tǒng)都會(huì)返回一個(gè)唯一識(shí)別碼RequestId 給 用戶。XML 返回返回示例:示例:4C467B38-3910-447D-87BC-AC049166F216 JSON 返回返回示例:示例:RequestId:4C467B38-3910-447D-87BC-AC049166F216,/*返回結(jié)果數(shù)據(jù)*/2.3 返回結(jié)果返回結(jié)果 調(diào)用 API 服務(wù)后返回?cái)?shù)據(jù)采用統(tǒng)一格式,返回的 HTTP 狀態(tài)碼為 2xx,9、代表調(diào)用成功;返回 4xx 或 5xx 的 HTTP 狀態(tài)碼代表調(diào)用失敗。調(diào)用成功返回的數(shù)據(jù)格式主要有 XML 和 JSON兩種,外部系統(tǒng)可以在請(qǐng)求時(shí)傳入?yún)?shù)來(lái)制定返回的數(shù)據(jù)格式,默認(rèn)為 XML 格式。本文檔中的返回示例為了便于用戶查看,做了格式化處理,實(shí)際返回結(jié)果是沒有進(jìn)行換行、縮進(jìn)等處理的。2.3.1 成功結(jié)果成功結(jié)果 XML 返回返回示例:示例:(XML 返回結(jié)果包括請(qǐng)求是否成功信息和具體的業(yè)務(wù)數(shù)據(jù))4C467B38-3910-447D-87BC-AC049166F216 JSON 示例:示例:RequestId:4C467B38-3910-447D-87BC-AC049166F216,10、/*返回結(jié)果數(shù)據(jù)*/2.3.2 錯(cuò)誤結(jié)果錯(cuò)誤結(jié)果 調(diào)用接口出錯(cuò)后,將不會(huì)返回結(jié)果數(shù)據(jù)。調(diào)用方可根據(jù)附表來(lái)定位錯(cuò)誤原因。當(dāng)調(diào)用出錯(cuò)時(shí),HTTP 請(qǐng)求返回一個(gè) 4xx 或 5xx 的 HTTP 狀態(tài)碼。返回的消息體中是具體的錯(cuò)誤代碼及錯(cuò)誤信息。另外還包含一個(gè)全局唯一的請(qǐng)求 ID:RequestId 和一個(gè)您該次請(qǐng)求訪問(wèn)的站點(diǎn) ID:HostId。在調(diào)用方找不到錯(cuò)誤原因時(shí),可以聯(lián)系阿里云客服,并提供該 HostId 和 RequestId,以便我們盡快幫您解決問(wèn)題。XML 示例:示例:8906582E-6722-409A-A6C4-0E7863B733A5 UnsupportedOperation 11、The specified action is not supported.JSON 示例:示例:RequestId:8906582E-6722-409A-A6C4-0E7863B733A5,HostId:,Code:UnsupportedOperation,Message:The specified action is not supported.2.4 簽名機(jī)制簽名機(jī)制 CDN 服務(wù)會(huì)對(duì)每個(gè)訪問(wèn)的請(qǐng)求進(jìn)行身份驗(yàn)證,所以無(wú)論使用 HTTP 還是 HTTPS 協(xié)議提交請(qǐng)求,都需要在請(qǐng)求中包含簽名(Signature)信息。CDN 通過(guò)使用 Access Key ID 和 Access Key 12、Secret 進(jìn)行對(duì)稱加密的方法來(lái)驗(yàn)證請(qǐng)求的發(fā)送者身份。Access Key ID 和 Access Key Secret由阿里云官方頒發(fā)給訪問(wèn)者(可以通過(guò)阿里云官方網(wǎng)站申請(qǐng)和管理),其中Access Key ID 用于標(biāo)識(shí)訪問(wèn)者的身份;Access Key Secret 是用于加密簽名字符串和服務(wù)器端驗(yàn)證簽名字符串的密鑰,必須嚴(yán)格保密,只有阿里云和用戶知道。用戶在訪問(wèn)時(shí),按照下面的方法對(duì)請(qǐng)求進(jìn)行簽名處理:1.使用請(qǐng)求參數(shù)構(gòu)造規(guī)范化的請(qǐng)求字符串(Canonicalized Query String)a)按照參數(shù)名稱的字典順序?qū)φ?qǐng)求中所有的請(qǐng)求參數(shù)(包括文檔中描述的“公共請(qǐng)求參數(shù)”和給定了的請(qǐng)求13、接口的自定義參數(shù),但不能包括“公共請(qǐng)求參數(shù)”中提到 Signature 參數(shù)本身)進(jìn)行排序。注:當(dāng)使用 GET 方法提交請(qǐng)求時(shí),這些參數(shù)就是請(qǐng)求 URI 中的參數(shù)部分(即URI 中“?”之后由“&”連接的部分)。b)對(duì)每個(gè)請(qǐng)求參數(shù)的名稱和值進(jìn)行編碼。名稱和值要使用 UTF-8 字符集進(jìn)行 URL編碼,URL 編碼的編碼規(guī)則是:i.對(duì)于字符 A-Z、a-z、0-9 以及字符“-”、“_”、“.”、“”不編碼;ii.對(duì)于其他字符編碼成“%XY”的格式,其中 XY 是字符對(duì)應(yīng) ASCII 碼的 16進(jìn)制表示。比如英文的雙引號(hào)(”)對(duì)應(yīng)的編碼就是%22 iii.對(duì)于擴(kuò)展的 UTF-8 字符,編碼成“%14、XY%ZA”的格式;iv.需要說(shuō)明的是英文空格()要被編碼是%20,而不是加號(hào)(+)。注:一般支持 URL 編碼的庫(kù)(比如 Java 中的 .URLEncoder)都是按照“application/x-www-form-urlencoded”的 MIME 類型的規(guī)則進(jìn)行編碼的。實(shí)現(xiàn)時(shí)可以直接使用這類方式進(jìn)行編碼,把編碼后的字符串中加號(hào)(+)替換成%20、星號(hào)(*)替換成%2A、%7E 替換回波浪號(hào)(),即可得到上述規(guī)則描述的編碼字符串。c)對(duì)編碼后的參數(shù)名稱和值使用英文等號(hào)(=)進(jìn)行連接。d)再把英文等號(hào)連接得到的字符串按參數(shù)名稱的字典順序依次使用&符號(hào)連接,即得到規(guī)范化請(qǐng)求字符串。2.使用上15、一步構(gòu)造的規(guī)范化字符串按照下面的規(guī)則構(gòu)造用于計(jì)算簽名的字符串:StringToSign=HTTPMethod+“&”+percentEncode(“/”)+”&”+percentEncode(CanonicalizedQueryString)其中 HTTPMethod 是提交請(qǐng)求用的 HTTP 方法,比 GET。percentEncode(“/”)是按照 1.b 中描述的 URL 編碼規(guī)則對(duì)字符“/”進(jìn)行編碼得到的值,即“%2F”。percentEncode(CanonicalizedQueryString)是對(duì)第 1 步中構(gòu)造的規(guī)范化請(qǐng)求字符串按1.b 中描述的 URL 編碼規(guī)則編碼后得到的16、字符串。3.按照 RFC2104 的定義,使用上面的用于簽名的字符串計(jì)算簽名 HMAC 值。注意:計(jì)算簽名時(shí)使用的 Key 就是用戶持有的 Access Key Secret 并加上一個(gè)“&”字符(ASCII:38),使用的哈希算法是 SHA1。4.按照 Base64 編碼規(guī)則把上面的 HMAC 值編碼成字符串,即得到簽名值(Signature)。5.將得到的簽名值作為 Signature 參數(shù)添加到請(qǐng)求參數(shù)中,即完成對(duì)請(qǐng)求簽名的過(guò)程。注意:得到的簽名值在作為最后的請(qǐng)求參數(shù)值提交給 CDN 服務(wù)器的時(shí)候,要和其他參數(shù)一樣,按照 RFC3986 的規(guī)則進(jìn)行 URL 編碼)。以DescribeCd17、nService為例,簽名前的請(qǐng)求 URL 為:http:/ 那么 StringToSign 就是:GET&%2F&AccessKeyId%3Dtestid%26Action%DescribeCdnService%26Format%3DXML%26RegionId%3Dregion1%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3DNwDAxvLU6tFE0DVb%26SignatureVersion%3D1.0%26TimeStamp%3D2012-12-26T10%253A33%253A56Z%26Version%3D2014-11-11 18、假如使用的 Access Key Id 是“testid”,Access Key Secret 是“testsecret”,用于計(jì)算 HMAC 的 Key 就是“testsecret&”,則計(jì)算得到的簽名值是:SDFQNvyH5rtkc9T5Fwo8DOjw5hc=簽名后的請(qǐng)求 URL 為(注意增加了 Signature 參數(shù)):http:/ 3 接口說(shuō)明接口說(shuō)明 3.1 OpenCdnService 描述描述 開通 CDN 服務(wù),只有開通后,才能進(jìn)行域名操作.一個(gè)用戶只能開通一次。開通條件:帳號(hào)已通過(guò)實(shí)名認(rèn)證 請(qǐng)求參數(shù)請(qǐng)求參數(shù) 參數(shù)參數(shù) 類型類型 必要必要 描述描述 Action Strin19、g 是 操作接口名,系統(tǒng)規(guī)定參數(shù),取值:OpenCdnService InternetChargeType String 是 開通服務(wù)的計(jì)費(fèi)類型:按流量、按帶寬峰值。如果用戶不指定,默認(rèn) PayByTraffic 按流量“PayByTraffic”按帶寬峰值“PayByBandwidth”特定錯(cuò)誤碼特定錯(cuò)誤碼 ErrorCode 錯(cuò)誤碼 Message 錯(cuò)誤信息 HTTP 狀態(tài) Forbidden.NotVerified Your account is not verified yet.403 InvalidParameter The specified value of parameter 20、is not valid.400 InvalidInternetChargeType.Mismatch Specified internet charge type violated with the previous one.400 CdnService.HasOpened Your cdn service has opened.400 示例示例 請(qǐng)求示例 https:/?&Action=OpenCdnService&InternetChargeType=PayByBandwidth&返回示例 JSON 格式:格式:RequestId:97C68796-EB7F-4D41-9D5B-12B921、09D76508 XML 格式:格式:FD4E70AC-B791-43FA-B7BD-2DED234094C1 3.2 DescribeCdnService 描述描述 查詢 CDN 服務(wù)狀態(tài)。包括:當(dāng)前計(jì)費(fèi)類型,服務(wù)開通時(shí)間,下次生效的計(jì)費(fèi)類型,當(dāng)前業(yè)務(wù)狀態(tài)等。請(qǐng)求參數(shù)請(qǐng)求參數(shù) 參數(shù)參數(shù) 類型類型 必要必要 描述描述 Action String 是 操作接口名,系統(tǒng)規(guī)定參數(shù),取值:DescribeCdnService 返回參數(shù)返回參數(shù) 名稱名稱 類型類型 描述描述 InternetChargeType String 計(jì)費(fèi)類型 PayByTraffic|PayByBandwidth Openin22、gTime String 開通服務(wù)時(shí)間,ISO 8601 時(shí)間格式 ChangingChargeType String 下次生效的計(jì)費(fèi)類型PayByTraffic|PayByBandwidth ChangingAffectTime Date GMT 時(shí)間 OperationLocks Struct 業(yè)務(wù)鎖定狀態(tài),例如:欠費(fèi),安全等 特定錯(cuò)誤碼特定錯(cuò)誤碼 ErrorCode 錯(cuò)誤碼 Message 錯(cuò)誤信息 HTTP 狀態(tài) OperationDenied Your account does not open 403 CDN service yet.示例示例 請(qǐng)求示例 https:/?&Actio23、n=ModifyCdnService&InternetChargeType=PayByTraffic&返回示例 JSON 格式:格式:RequestId:97C68796-EB7F-4D41-9D5B-12B909D76508 XML 格式:格式:FD4E70AC-B791-43FA-B7BD-2DED234094C1 3.3 ModifyCdnService 描述描述 變更 CDN 服務(wù)的計(jì)費(fèi)類型.需先開通才可執(zhí)行此操作。變更計(jì)費(fèi)類型,次日 00:00 生效;多次變更以最新提交的為準(zhǔn)。計(jì)費(fèi)類型:按峰值帶寬計(jì)費(fèi) 按使用流量計(jì)費(fèi) 請(qǐng)求參數(shù)請(qǐng)求參數(shù) 參數(shù)參數(shù) 類型類型 必要必要 描述描述 Acti24、on String 是 操作接口名,系統(tǒng)規(guī)定參數(shù),取值:ModifyCdnService InternetChargeType String 是 開通服務(wù)的計(jì)費(fèi)類型:按流量、按帶寬峰值。用戶必須指定類型:按流量“PayByTraffic”按帶寬峰值“PayByBandwidth”特定錯(cuò)誤碼特定錯(cuò)誤碼 ErrorCode 錯(cuò)誤碼 Message 錯(cuò)誤信息 HTTP 狀態(tài) OperationDenied Your account does not open CDN service yet.403 InvalidParameter The specified value of parameter i25、s not valid.400 InsufficientBalance Your account does not have enough balance.400 Forbidden.NotVerified Your account is not verified yet.403 示例示例 請(qǐng)求示例:https:/?&Action=DescribeCdnService&返回示例:JSON 格式:格式:ChangingAffectTime:2014-11-27T16:00:00Z,ChangingChargeType:PayByBandwidth,InternetChargeType:PayBy26、Traffic,OpeningTime:2014-02-28T13:11:49Z,OperationLocks:LockReason:,RequestId:BFFCDFAD-DACC-484E-9BE6-0AF3B3A0DD23 XML 格式:格式:2014-11-27T16:00:00Z PayByBandwidth PayByTraffic 2014-02-28T13:11:49Z A3B16623-3A44-48D0-B19A-5799E13C8CCB 3.4 DescribeUserDomains 描述描述 查詢用戶名下所有的域名與狀態(tài)。域名狀態(tài)包括:運(yùn)行中(表示域名服務(wù)狀態(tài)正常)已停27、止、配置中、配置失敗 請(qǐng)求參數(shù)請(qǐng)求參數(shù) 參數(shù)參數(shù) 類型類型 必須必須?描述描述 Action String 是 操作接口名,系統(tǒng)規(guī)定參數(shù),取值:DescribeUserDomains PageSize Integer 否 分頁(yè)大小,默認(rèn) 20,最大 50。取值:150 之前的任意整數(shù) PageNumber Integer 否 取得第幾頁(yè),取值范圍為:1100000。返回參數(shù)返回參數(shù) 名稱名稱 類型類型 描述描述 Domains Struct Domain組成的列表。PageSize Integer 整頁(yè)大小 PageNumber Integer 返回?cái)?shù)據(jù)的頁(yè)碼 TotalCount Integ28、er 總條數(shù) 特定錯(cuò)誤碼特定錯(cuò)誤碼 ErrorCode 錯(cuò)誤碼 Message 錯(cuò)誤信息 HTTP 狀態(tài) OperationDenied Your account does not open CDN service yet.403 示例示例 請(qǐng)求示例 https:/?&Action=DescribeUserDomains&PageNumber=1&PageSize=5&返回示例 JSON 格式:格式:Domains:CDNDomain:DomainName:*.*.com,DomainStatus:online ,DomainName:*.*.com,DomainStatus:online ,29、DomainName:*.*.com,DomainStatus:online ,DomainName:*.*.com,DomainStatus:online ,DomainName:*.*.com,DomainStatus:configure_failed ,PageNumber:1,PageSize:5,TotalCount:14,RequestId:9D73CF5C-FAD6-4DE1-BA0F-6DAABE66BE9F XML 格式:格式:*.*.com online *.*.com offline *.*.com online *.*.com online *.*.com config30、ure_failed 1 5 14 E107FDE8-84D9-465D-B73B-DF41BADB0049 3.5 RefreshObjectCaches 描述描述 刷新指定刷新指定 URL 內(nèi)容至內(nèi)容至 Cache 節(jié)點(diǎn)節(jié)點(diǎn),每次每次只能只能提交一個(gè)提交一個(gè) url。請(qǐng)求參數(shù)請(qǐng)求參數(shù) 參數(shù)參數(shù) 類型類型 必須必須?描述描述 Action String 是 操作接口名,系統(tǒng)規(guī)定參數(shù),取值:RefreshObjectCaches ObjectPath String 是 輸入示例: ObjectType String 否 可選,刷新的類型,其值可以為 File|Direcotry,默認(rèn)是 Fil31、e。返回參數(shù)返回參數(shù) 名稱名稱 類型類型 描述描述 RefreshTaskId String 刷新返回的任務(wù) ID 特定錯(cuò)誤碼特定錯(cuò)誤碼 ErrorCode 錯(cuò)誤碼 Message 錯(cuò)誤信息 HTTP 狀態(tài) Throttling Request was denied due to request throttling.503 OperationDenied Your account does not open CDN service yet.403 InvalidDomain.Offline Specified domain is offline.400 QuotaExceeded.Refre32、sh exceed the prescribed limits 400 InvalidDomain.Configuring Specified domain is configuring.400 InvalidDomain.Specified domain is 400 Configure_failed configure_failed InvalidParameter The specified value of parameter is not valid.400 InvalidParameter.Mismatch Specified object path does not math t33、he specified object type.400 示例示例 請(qǐng)求示例 https:/?&Action=RefreshObjectCaches&ObjectPath= JSON 格式:格式:RefreshTaskId:704222904,RequestId:D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C XML 格式:格式:704225667 AB14769A-A5F2-4CCD-B85B-3368DFF63C0A 3.6 DescribeRefreshTasks 描述描述 查詢刷新狀態(tài),是否在全網(wǎng)生效。支持根據(jù)任務(wù) ID 查詢、URL 查詢 taskid 與 34、objectpath 都不指定,默認(rèn)查 7 天內(nèi),第一頁(yè)的數(shù)據(jù)(20 條)Taskid 與 objectpath 可以同時(shí)指定,邏輯與的關(guān)系 只可查詢 7 天內(nèi)的數(shù)據(jù) 請(qǐng)求參數(shù)請(qǐng)求參數(shù) 參數(shù) 類型 必須?描述 Action String 是 操作接口名,系統(tǒng)規(guī)定參數(shù),取值:DescribeRefreshTasks TaskId String 否 按任務(wù) Id 查詢刷新狀態(tài) ObjectPath String 否 通過(guò)對(duì)象路徑,查詢刷新狀態(tài) PageSize Integer 否 分頁(yè)大小,默認(rèn) 20,最大 50。取值:150 之前的任意整數(shù) PageNumber Integer 否 取得第幾頁(yè)。35、取值范圍為:1100000 返回參數(shù)返回參數(shù) 名稱名稱 類型類型 描述描述 Tasks Struct TaskItem 組成的 Task 任務(wù)列表。PageSize Integer 整頁(yè)大小 PageNumber Integer 頁(yè)碼 TotalCount Integer 總條數(shù) 特定錯(cuò)誤碼特定錯(cuò)誤碼 ErrorCode 錯(cuò)誤碼 Message 錯(cuò)誤信息 HTTP 狀態(tài) OperationDenied Your account does not open 403 CDN service yet.InvalidParameter The specified value of parameter 36、is not valid.400 示例示例 請(qǐng)求示例:https:/?&Action=DescribeRefreshTasks&ObjectPath=&PageNumber=1&PageSize=10&返回示例:JSON 格式:Tasks:CDNTask:CreationTime:2014-11-27T08:23:22Z,ObjectPath:http:/ ,CreationTime:2014-11-27T08:18:38Z,ObjectPath:http:/ ,CreationTime:2014-11-27T07:58:58Z,ObjectPath:http:/ ,CreationTime:37、2014-11-27T07:58:31Z,ObjectPath:http:/ ,CreationTime:2014-11-27T07:56:54Z,ObjectPath:http:/ ,CreationTime:2014-11-27T07:56:42Z,ObjectPath:http:/ ,CreationTime:2014-11-27T07:56:11Z,ObjectPath:http:/ ,CreationTime:2014-11-27T04:06:27Z,ObjectPath:http:/ ,PageNumber:1,PageSize:10,TotalCount:8,RequestId:38、174F6032-AA26-470D-B90E-36F0EB205BEE XML 格式:2014-11-27T08:23:22Z http:/ Complete 704225667 2014-11-27T08:18:38Z http:/ Complete 704222904 2014-11-27T07:58:58Z http:/ 704211692 2014-11-27T07:58:31Z http:/ Complete 704211414 2014-11-27T07:56:54Z http:/ 704210512 2014-11-27T07:56:42Z http:/ Complete 7039、4210368 2014-11-27T07:56:11Z http:/ Complete 704210004 2014-11-27T04:06:27Z http:/ Complete 704081031 1 10 8 13DF2E2F-FBF8-4E1C-9222-98141795443D 3.7 DescribeCdnMonitorData 描述描述 獲取域名最小 5 分鐘粒度的監(jiān)控?cái)?shù)據(jù)。包括:請(qǐng)求命中率、字節(jié)命中率、QPS、流量、平均響應(yīng)時(shí)間。不指定 StartTime 和 EndTime 時(shí),默認(rèn)讀取過(guò)去 24 小時(shí)的數(shù)據(jù),同時(shí)支持按指定的起止時(shí)間查詢,兩者需要同時(shí)指定。一次最多 1 個(gè)40、域名 最多可獲取最近 30 天的數(shù)據(jù) 請(qǐng)求參數(shù)請(qǐng)求參數(shù) 參數(shù)參數(shù) 類型類型 必須必須?描述描述 Action String 是 操作接口名,系統(tǒng)規(guī)定參數(shù),取值:DescribeCdnMonitorData DomainName String 是 取值:,StartTime String 否 獲取監(jiān)控信息的最近時(shí)間點(diǎn),日期格式按照ISO8601 表示法,并使用 UTC 時(shí)間。格式為:YYYY-MM-DDThh:mm:ssZ 最小數(shù)據(jù)粒度為 5 分鐘;不寫默認(rèn)讀取過(guò)去 24 小時(shí)數(shù)據(jù) EndTime String 否 結(jié)束時(shí)間需大于起始時(shí)間;獲取監(jiān)控信息的最近時(shí)間點(diǎn),日期格式按照 ISO8601 41、表示法,并使用 UTC 時(shí)間。格式為:YYYY-MM-DDThh:mm:ssZ 返回參數(shù)返回參數(shù) 參數(shù)名稱 參數(shù)類型 參數(shù)說(shuō)明 DomainName String DomainName。MonitorInterval String 每條記錄的時(shí)間間隔,以秒為單位。本期為固定值300S。StartTime DateTime 開始時(shí)間 EndTime DateTime 結(jié)束時(shí)間 MonitorDatas MonitorDataItem MonitorDataItem 組成的數(shù)組。特定錯(cuò)誤特定錯(cuò)誤 ErrorCode 錯(cuò)誤碼 Message 錯(cuò)誤信息 HTTP 狀態(tài) OperationDenied 42、Your account does not open CDN service yet.403 InvalidParameter The specified value of parameter“”is not valid.400 InvalidEndTime.Mismatch Specified end time does not math the specified start time.400 MissingParameter An input parameter that is mandatory for processing the request is not supplied.4043、0 InvalidStartTime.Malformed Specified start time is malformed.400 InvalidEndTime.Malformed Specified end time is malformed.400 示例示例 請(qǐng)求示例:https:/?&Action=DescribeCdnMonitorData&DomainName=&StartTime=2014-11-15T00:00:00Z&EndTime=2014-11-24T00:00:00Z&返回示例:JSON 格式 MonitorDatas:CDNMonitorData:AverageObj44、ectSize:860.5,BytesHitRate:0.0,BytesPerSecond:137,QueryPerSecond:0.02,RequestHitRate:0.0,TimeStamp:2014-11-22T16:00:00Z ,AverageObjectSize:860.5,BytesHitRate:0.0,BytesPerSecond:91,QueryPerSecond:0.01,RequestHitRate:0.0,TimeStamp:2014-11-22T17:00:00Z ,AverageObjectSize:859.833333333333,BytesHitRate:045、.0,BytesPerSecond:91,QueryPerSecond:0.01,RequestHitRate:0.0,TimeStamp:2014-11-19T04:00:00Z ,AverageObjectSize:477.2,BytesHitRate:37.1542330259849,BytesPerSecond:436,QueryPerSecond:0.11,RequestHitRate:42.5,TimeStamp:2014-11-18T18:00:00Z ,DomainName:,EndTime:2014-11-24T00:00:00Z,MonitorInterval:3600,S46、tartTime:2014-11-15T00:00:00Z,RequestId:7B2B8D2B-F507-4045-B39B-B421CBE81888 XML 格式:860.5 0.0 137 0.02 0.0 2014-11-22T16:00:00Z 860.5 0.0 91 0.01 0.0 2014-11-22T17:00:00Z 859.833333333333 0.0 91 0.01 0.0 2014-11-19T04:00:00Z 2014-11-24T00:00:00Z 3600 2014-11-15T00:00:00Z 27D39332-8ED8-4D23-97E4-3C9A47、1DB07E23 4 數(shù)據(jù)類型數(shù)據(jù)類型 MonitorDataItem 描述描述 MonitorDataItem 數(shù)據(jù)的類型。節(jié)點(diǎn)名節(jié)點(diǎn)名 MonitorDataItem 子節(jié)點(diǎn)子節(jié)點(diǎn) 名稱名稱 類型類型 描述描述 TimeStamp String 當(dāng)前統(tǒng)計(jì)數(shù)據(jù)的時(shí)間戳,UTC 時(shí)間 QueryPerSecond String 總的 QPS 大小 BytesPerSecond String 帶寬量 BytesHitRate String 字節(jié)命中率 RequestHitRate String 請(qǐng)求命中率 AverageObjectSize String 平均響應(yīng)大小(Byte)Domain 數(shù)48、據(jù)類型 描述描述 Domain 數(shù)據(jù)的類型。節(jié)點(diǎn)名節(jié)點(diǎn)名 Domain 子節(jié)點(diǎn)子節(jié)點(diǎn) 名稱名稱 類型類型 描述描述 DomainName String 刷新返回的任務(wù) ID Status String Online|Offline|configuring|configure_failed|狀態(tài)的一種。TaskItem 數(shù)據(jù)類型 描述描述 TaskItem 數(shù)據(jù)的類型。節(jié)點(diǎn)名節(jié)點(diǎn)名 TaskItem 子節(jié)點(diǎn)子節(jié)點(diǎn) 名稱名稱 類型類型 描述描述 TaskId String 任務(wù) Id。ObjectPath String 刷新對(duì)象路徑。Status String Pending|Refreshing49、|Failed|Complete狀態(tài)中的一個(gè)。Pending:表示啟動(dòng)刷新中 Refreshing:刷新中 Failed:刷新失敗 Complete:刷新成功 CreationTime DateTime 任務(wù)對(duì)象創(chuàng)建時(shí)間,UTC 時(shí)間。5 附錄附錄 5.1 錯(cuò)誤代碼表錯(cuò)誤代碼表 5.1.1 客戶端錯(cuò)誤客戶端錯(cuò)誤 錯(cuò)誤代碼錯(cuò)誤代碼 描述描述 HTTPHTTP 狀態(tài)碼狀態(tài)碼 UnsupportedOperation The specified action is not supported.400 NoSuchVersion The specified version does not exist50、.400 UnsupportedParameter The parameter”is not supported.400 MissingParameter The input parameter that is mandatory for processing this request is not supplied.400 InvalidParameter The specified parameter is not valid.Or The specified image does not support the specified instance type.400 Throttling51、 Request was denied due to request throttling.400 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records.404 Forbidden User not authorized to operate on the specified resource.403 Forbidden.RiskControl This operation is forbidden by Aliyun Risk Control system.403 Forbid52、den.AccessTooManyOthersRThis operator is forbidden because too 403 錯(cuò)誤代碼錯(cuò)誤代碼 描述描述 HTTPHTTP 狀態(tài)碼狀態(tài)碼 esource many other ones resource to be accessed.SignatureDoesNotMatch The signature we calculated does not match the one you provided.Please refer to the API reference about authentication for details.4053、3 SignatureNonceUsed The request signature nonce has been used.400 IdempotentParameterMismatch Request uses a client token in a previous request but is not identical to that request.400 ChargeTypeViolation Operations on this kind of resources are not permitted.403 InsufficientBalance Your account do54、es not have enough balance.400 QuotaExceeded Living instances quota exceeded.400 OperationDenied Specified operation is denied as your resource is locked for security reasons.403 RiskControl.Refused Your action was.refused by RiskControl.400 QuotaExceeded.Snapshot Snapshot quota exceeded.400 QuotaEx55、ceeded.Image Image quota exceeded.400 5.1.2 服務(wù)器端錯(cuò)誤服務(wù)器端錯(cuò)誤 錯(cuò)誤代碼錯(cuò)誤代碼 描述描述 HTTPHTTP 狀態(tài)代碼狀態(tài)代碼 InternalError The request processing has failed due to some unknown error,exception or failure.500 ServiceUnAvailable The request has failed due to a temporary failure of the server.503 5.2 如何調(diào)用接口如何調(diào)用接口 對(duì) CDN 服務(wù)56、接口的調(diào)用是通過(guò)向 CDN 服務(wù)端發(fā)送 HTTP 請(qǐng)求(可以通過(guò) HTTP 或 HTTPS通道發(fā)送),并獲取 CDN 服務(wù)對(duì)該請(qǐng)求響應(yīng)結(jié)果的過(guò)程。CDN 服務(wù)端在接收到用戶請(qǐng)求后,對(duì)請(qǐng)求做必要的身份驗(yàn)證和參數(shù)驗(yàn)證,在所有驗(yàn)證成功后根據(jù)請(qǐng)求的指定參數(shù)提交或完成相應(yīng)操作,并把處理的結(jié)果以 HTTP 響應(yīng)地形式返回給調(diào)用者。5.2.1 請(qǐng)求組成請(qǐng)求組成 請(qǐng)求由以下幾個(gè)部分組成:HTTP 方法目前 cdn 服務(wù)的所有接口只支持 GET 方法的調(diào)用。請(qǐng)求 URL請(qǐng)求的服務(wù)地址、要執(zhí)行的操作名稱、操作參數(shù)和公共請(qǐng)求參數(shù)都包含在請(qǐng)求的 URL 中。服務(wù)端地址:cdn 服務(wù)的域名是http:/ HTTPS 通57、道。(HTTPS加入了 SSL 層對(duì)通信進(jìn)行了加密,可以防止通信被截獲而導(dǎo)致敏感信息泄露。)操作名稱:每個(gè)接口都需要指定要執(zhí)行的操作名稱,即 Action 參數(shù)。操作參數(shù):根據(jù)要執(zhí)行的操作不同,需要傳入不同的操作參數(shù),詳見每個(gè)接口的說(shuō)明。公共請(qǐng)求參數(shù):包含時(shí)間戳、簽名信息等每個(gè)請(qǐng)求都要包含的參數(shù)。為了使服務(wù)端能夠正確地驗(yàn)證用戶的身份并授權(quán)請(qǐng)求執(zhí)行,請(qǐng)求在提交前要進(jìn)行簽名處理。簽名的規(guī)則參見簽名機(jī)制一節(jié)。在服務(wù)端對(duì)請(qǐng)求處理完成后,會(huì)返回響應(yīng)結(jié)果。響應(yīng)結(jié)果分為成功結(jié)果和錯(cuò)誤消息,格式描述參見 JSON 返回示例:RequestId:4C467B38-3910-447D-87BC-AC049166F58、216,/*返回結(jié)果數(shù)據(jù)*/返回結(jié)果一節(jié)。客戶端可以解析響應(yīng)的消息體,得到執(zhí)行結(jié)果。5.2.2 調(diào)用示例調(diào)用示例 以DescribeCdnService接口為例:對(duì)應(yīng)的 Action 是DescribeCdnService。在添加了所有公共請(qǐng)求參數(shù)(除 Signature)后,請(qǐng)求的 URL 是(為了便于閱讀,這里是進(jìn)行 URL 編碼前的 URL):http:/ 按照簽名計(jì)算規(guī)則,先構(gòu)造出規(guī)范化請(qǐng)求字符串(Canonicalized Query String),如下:http:/ 再構(gòu)造出用于簽名的字符串 StringToSign 值為:GET&%2F&AccessKeyId%3Dtestid59、%26Action%DescribeCdnService%26Format%3DXML%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3DNwDAxvLU6tFE0DVb%26SignatureVersion%3D1.0%26TimeStamp%3D2012-12-26T10%253A33%253A56Z%26Version%3D2014-11-11 以下 Java 示例代碼演示了如何添加公共請(qǐng)求參數(shù)、如何構(gòu)造用請(qǐng)求參數(shù)構(gòu)造規(guī)范化請(qǐng)求字符串,以及如何構(gòu)造StringToSign字符串。示例假定所有請(qǐng)求參數(shù)放在一個(gè)Map對(duì)象里,使用的 Access60、 Key ID 是“testid”。final String HTTP_METHOD=GET;其中需要注意的是,TimeStamp 參數(shù)要求符合ISO8601規(guī)范,并注意使用 UTC 時(shí)間,否則會(huì)遇到錯(cuò)誤。下面的示例代碼演示了如何生成符合規(guī)范的 TimeStamp 字符串:private static final String ISO8601_DATE_FORMAT=yyyy-MM-ddTHH:mm:ssZ;private static String formatIso8601Date(Date date)SimpleDateFormat df=new SimpleDateFormat(ISO61、8601_DATE_FORMAT);df.setTimeZone(new SimpleTimeZone(0,GMT);return df.format(date);生成規(guī)范化請(qǐng)求字符串(示例中的 canonicalizedQueryString 變量),以及stringToSign 時(shí),都需要進(jìn)行必要的編碼。編碼的規(guī)則在簽名機(jī)制一節(jié)中有詳細(xì)描述。下面的示例代碼演示了如何用 .URLEncoder 類完成編碼:private static final String ENCODING=UTF-8;private static String percentEncode(String value)th62、rows UnsupportedEncodingException return value!=null?URLEncoder.encode(value,ENCODING).replace(+,%20).replace(*,%2A).replace(%7E,):null;假定使用的 Access Key Id 是“testid”,Access Key Secret 是“testsecret”,用于計(jì)算 HMAC 的 Key 就是“testsecret&”,最終計(jì)算得到的簽名值為:SDFQNvyH5rtkc9T5Fwo8DOjw5hc=計(jì)算簽名的示例代碼(Java):/以下是一段計(jì)算簽名的示例代63、碼 final String ALGORITHM=HmacSHA1;final String ENCODING=UTF-8;key=testsecret&;Mac mac=Mac.getInstance(ALGORITHM);mac.init(new SecretKeySpec(key.getBytes(ENCODING),ALGORITHM);byte signData=mac.doFinal(stringToSign.getBytes(ENCODING);String signature=new String(Base64.encodeBase64(signData);增加簽名參數(shù)后,請(qǐng)按64、照 RFC3986 規(guī)則進(jìn)行 URL 編碼后得到的 http:/ 接下來(lái),通過(guò) HTTP 請(qǐng)求的方式向上面的 URL 地址發(fā)送 HTTP 請(qǐng)求,并得到 CDN 服務(wù)端的響應(yīng)結(jié)果(示例):通過(guò)解析這個(gè) XML 結(jié)果即可以得到所有可用的地域 Id 和 LocalName 的列表。如果在提交請(qǐng)求時(shí),指定 Format 參數(shù)為 JSON,那么返回結(jié)果的格式為 JSON 格式。5.3 如何保證冪等性如何保證冪等性 當(dāng)通過(guò)調(diào)用創(chuàng)建實(shí)例接口在 CDN 中創(chuàng)建云服務(wù)器時(shí),如果遇到了請(qǐng)求超時(shí)或服務(wù)器內(nèi)部錯(cuò)誤時(shí),客戶端可能會(huì)嘗試重發(fā)請(qǐng)求,這時(shí)客戶端可以通過(guò)提供可選參數(shù) ClientToken 避免服務(wù)器創(chuàng)建出比預(yù)65、期要多的實(shí)例,也就是通過(guò)提供 ClientToken 參數(shù)保證請(qǐng)求的冪等性。ClientToken 是一個(gè)由客戶端生成的唯一的、大小寫敏感、不超過(guò) 64 個(gè) ASCII 字符的字符串。如果用戶使用同一個(gè) ClientToken 值調(diào)用創(chuàng)建實(shí)例接口,則服務(wù)端會(huì)返回相同的請(qǐng)求結(jié)果,包含相同的 InstanceId。因此用戶在遇到錯(cuò)誤進(jìn)行重試的時(shí)候,可以通過(guò)提供相同的ClientToken 值,來(lái)確保 CDN 只創(chuàng)建一個(gè)實(shí)例,并得到這個(gè)實(shí)例的 InstanceId。如果用戶提供了一個(gè)已經(jīng)使用過(guò)的 ClientToken,但其他請(qǐng)求參數(shù)不同,則 CDN 會(huì)返回IdempotentParameterMi66、smatch 的錯(cuò)誤代碼。但需要注意的是,SignatureNonce、Timestamp和Signature參數(shù)在重試時(shí)是需要變化的,因?yàn)閏dn使用SignatureNonce來(lái)防止重放攻擊,使用 Timestamp 來(lái)標(biāo)記每次請(qǐng)求時(shí)間,所以再次請(qǐng)求必須提供不同的 SignatureNonce 和Timestamp 參數(shù)值,這同時(shí)也會(huì)導(dǎo)致 Signature 值的變化。通常,客戶端只需要在 500(InternetError)或 503(ServiceUnAvailableAvailable)錯(cuò)誤、或者無(wú)法得到響應(yīng)結(jié)果的情況下進(jìn)行重試操作。返回結(jié)果是 200 時(shí),重試可以得到上次相同的結(jié)果,67、但不會(huì)對(duì)服務(wù)端狀態(tài)帶來(lái)任何影響。而對(duì) 4xx 的返回錯(cuò)誤,除非提示信息里明確出現(xiàn)“try it later”,通常重試也是不能成功的。5.4 欠費(fèi)狀態(tài)下的欠費(fèi)狀態(tài)下的 API 行為行為 下列表中,“-”表示無(wú)關(guān),“正常邏輯邏輯”表示按照接口的正常邏輯邏輯執(zhí)行并返回結(jié)果。5.4.1 賬戶賬戶欠費(fèi)時(shí)欠費(fèi)時(shí) 接口接口 行為行為 描述描述 OpenCdnServiceOpenCdnService 正常正常 DescribeCdnServiceDescribeCdnService 正常正常 OperationLocksOperationLocks 會(huì)出會(huì)出現(xiàn)現(xiàn) FinancialFinancial 的鎖的鎖 ModifyCdnServiceModifyCdnService 異常異常 出現(xiàn)出現(xiàn)InsufficientBalanceInsufficientBalance錯(cuò)誤碼錯(cuò)誤碼 RefreshObjectCachesRefreshObjectCaches 異常異常 出現(xiàn)出現(xiàn)InsufficientBalanceInsufficientBalance錯(cuò)誤碼錯(cuò)誤碼 DescribeRefreshTaskDescribeRefreshTask 正常正常 DescribeCdnMonitorDataDescribeCdnMonitorData 正常正常
物業(yè)資料
上傳時(shí)間:2021-02-04
9份
培訓(xùn)課件
上傳時(shí)間:2022-06-15
20份
節(jié)日策劃
上傳時(shí)間:2025-02-05
34份
運(yùn)營(yíng)管理
上傳時(shí)間:2022-06-30
8份
培訓(xùn)課件
上傳時(shí)間:2022-06-16
6份
運(yùn)營(yíng)管理
上傳時(shí)間:2022-06-15
23份