nga能查服务器状态吗,NGAA
接口概述
本文檔對CCSP系統提供的API接口進行說明，供其它業務系統集成調用。
API接口概覽添加加速域名：AddCdnDomain
關閉加速域名：StopCdnDomain
啟動加速域名：StartCdnDomain
刪除加速域名：DeleteCdnDomain
獲取加速域名列表：GetCdnDomainList
獲取加速域名配置：GetCdnDomain
修改源站配置：EditOriginConfig
刪除源站配置：DeleteOriginConfig
防盜鏈設置：SetRefer
刪除防盜鏈：DeleteRefer
緩存設置：SetCacheConfig
修改緩存設置：EditCacheConfig
刪除緩存設置：DeleteCacheConfig
HttpHeader設置：SetHttpHeaderConfig
修改HttpHeader：EditHttpHeaderConfig
刪除HttpHeader：DeleteHttpHeaderConfig
Https證書設置：SetHttpsInfo
刪除Https證書：DeleteHttpsInfo
緩存批量刷新：CreateRefreshTask
刷新任務結果查詢：DescribeRefreshTask
緩存預熱：createPreload
預熱任務查詢：preloadQuery
命中流量統計：DescribeCacheHitFlux
命中請求數統計：DescribeCacheHitNum
狀態碼請求數統計：DescribeHttpCode
帶寬統計：DescribeBandwidth
流量統計：DescribeFlux
回源帶寬統計：DescribeOriginBandwidth
回源流量統計：DescribeOriginFlux
請求數統計：DescribeVisitor
日志下載：DescribeDownloadLog
請求結構
服務地址
服務入口地址為：http://[hostAddress]/ccsp/action/api/v3/Action
注：Action為請求操作的功能名稱，內容按各接口實際情況替換。
通信協議
支持通過 HTTP 通道進行請求通信。
請求方法
支持HTTP GET和POST方法發送請求，GET請求時，請求參數需要全部包含在請求的URL路徑中。
字符編碼
請求及返回結果請使用 UTF-8 字符集進行編碼。
注意：編碼時空格要轉換成 “%20” , 而不是 “+”。
公共請求參數
公共請求參數是指每個接口都需要設置的請求參數，全部為必填項，在具體的接口描述中不再進行重復說明。
名稱
類型
必須
描述
accessKeyId
String
是
訪問服務的身份標識
signature
String
是
簽名字符串，關于簽名的計算方法，請參見簽名機制小節2.6。
timestamp
Long
是
請求的時間戳，從格林威治時間1970年01月01日00時00分00秒起至現在的總毫秒數。
簽名機制
API接口服務會對每個訪問的請求進行身份驗證，所以每次提交請求，都需要在請求中包含簽名(signature)信息。服務端通過使用 accessKeyId和 secretKey 進行對稱加密的方法來驗證請求的發送者身份。accessKeyId和secretKey在統創建系用戶時，自動生成。其中 accessKeyId用于標識訪問者的身份；secretKey是用于加密簽名字符串和服務器端驗證簽名字符串的密鑰，必須嚴格保密，只有用戶自己知道。
用戶在訪問時，按照下面的方法對請求進行簽名處理：
signature=hmacsha1((accessKeyId+”\n”+timestamp).getBytes(),secureKey. getBytes())；
import java.security.MessageDigest;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
String hmacsha1(byte[] data, byte[] key) {
SecretKeySpec signingKey = new SecretKeySpec(key, “HmacSHA1”);
Mac mac = Mac.getInstance(HMAC_SHA1);
mac.init(signingKey);
byte[] rawHmac = mac.doFinal(data);
return org.apache.commons.codec.binary.Base64.encodeBase64String(rawHmac);
注意：“\n” 是換行符，不要將 “\” 轉義。也就是說，不要用 “\n”。
請求樣例
http://[hostAddress]/ccsp/action/api/v3/Action?xxx&accessKeyId=xxx×tamp=xxx&signature=xxx&參數1=XXX&參數2=xxx&...參數n=xxx
應答結構
數據格式
所有API接口，返回數據格式為標準JSON格式。
公共應答參數名稱
類型
必須
描述
requestId
string
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
string
是
本次請求的描述信息
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List(Object)
否
返回的數據實體對象集合
應答樣例成功樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": [
{/*具體的接口返回內容*/}
]
}
失敗樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "400",
"code": " Missing.Parameter",
"message": "The request parameter is miss.password",
"data": [
{
}
]
}
返回狀態碼
API有完善的錯誤碼機制，API調用失敗會返回響應的Http碼、錯誤碼以及錯誤描述。
Http碼為4XX的是客戶端錯誤，建議用戶根據錯誤描述，修正請求后重新提交。
Http碼為5XX的是服務內部錯誤，此時建議重試。
公共HTTP狀態碼httpCode
說明
200
成功
400
缺少參數或參數無效
401
鑒權錯誤
403
沒有權限
500
服務內部錯誤
公共CODE狀態碼code
說明
Invalid.Paramater
無效的參數，一般為參數格式錯誤
Missing.Parameter
缺少參數。
Forbidden.[XXX]
鑒權錯誤，一般為沒有權限
Internal.Error
服務內部錯誤
Success
成功
域名管理接口列表
添加加速域名請求地址
http://[hostAddress]/ccsp/action/api/v3/AddCdnDomain
接口描述
添加加速域名。
請求參數
名稱
類型
必須
描述
domainName
String
是
域名(要求必須通過工信部備案)
origin
String
是
源站設置，支持配置一個域名或多個源站IP,多源站IP地址間以;分隔，端口可配置區間 0 ~ 65535。域名模式 : www.xxx.com:8080IP 模式：61.1.1.1:8080;62.2.2.2:8080
icpNumber
String
是
域名備案號
serviceType
String
否
服務類型，為空時默認靜態加速。web：靜態加速; download：下載加速; video：視頻加速
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
關閉加速域名請求地址
http://[hostAddress]/ccsp/action/api/v3/StopCdnDomain
接口描述
關閉加速域名。
請求參數
名稱
類型
必須
描述
domainName
String
是
域名
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
啟動加速域名請求地址
http://[hostAddress]/ccsp/action/api/v3/StartCdnDomain
接口描述
啟動加速域名。
請求參數
名稱
類型
必須
描述
domainName
String
是
域名
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
刪除加速域名請求地址
http://[hostAddress]/ccsp/action/api/v3/DeleteCdnDomain
接口描述
刪除加速域名。
請求參數
名稱
類型
必須
描述
domainName
String
是
域名
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
獲取加速域名列表請求地址
http://[hostAddress]/ccsp/action/api/v3/GetCdnDomainList
接口描述
獲取所有加速域名列表。
請求參數
名稱
類型
必須
描述
accessKeyId
String
是
訪問服務的身份標識
signature
String
是
簽名字符串，關于簽名的計算方法，請參見簽名機制小節2.6。
timestamp
Long
是
請求的時間戳，從格林威治時間1970年01月01日00時00分00秒起至現在的總毫秒數。
返回參數
名稱
類型
描述
data
List
域名對象集合，見【Item】描述
【Item】
名稱
類型
描述
id
Long
加速域名數據唯一標識
domainName
String
加速域名
icpNumber
String
域名備案號
status
String
加速域名狀態， online：已啟 deploying：部署中 deployfailed：部署失 offline：已關閉
serviceType
String
服務類型 web：靜態加速 download：下載加速 video：視頻加速
cname
Sting
CDN分配的后綴加速域名
createTime
Date
創建時間,格式yyyy-MM-dd HH:mm:ss
返回樣例
{
"requestId": "123d4387-15cb-4e3f-8c14-a90ca5137c31",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 2,
"data": [
{
"id": 1,
"domainName": "xx.ngaa.com.cn",
"icpNumber": "1232222111",
"status": "deploying",
"serviceType": "web",
"cname": "xx.ngaa.com.cn.ngaagslb.cn",
"createTime": "2017-07-04 08:21:37"
},
{
"id": 2,
"domainName": "www.xx.zhoufengjie.cn",
"icpNumber": "IC1B1",
"status": "deploying",
"serviceType": "download",
"cname": "www.xx.zhoufengjie.cn.ngaagslb.cn",
"createTime": "2018-03-15 05:44:05"
}
]
}
獲取加速域名配置請求地址
http://[hostAddress]/ccsp/action/api/v3/GetCdnDomain
接口描述
獲取加速域名配置。
請求參數
名稱
類型
必須
描述
domainId
Long
否
加速域名唯一標識，domainName為空時，此值不能為空。
domainName
String
否
加速域名，domainId為空時，此值不能為空。
返回參數
名稱
類型
描述
domainId
Long
加速域名數據唯一標識
domainName
String
加速域名
icpNumber
String
域名備案號
status
String
加速域名狀態， online：已啟 deploying：部署中 deployfailed：部署失 offline：已關閉
serviceType
String
服務類型 web：靜態加速 download：下載加速 video：視頻加速
cname
Sting
CDN分配的后輟加速域名
createTime
Date
創建時間,格式yyyy-MM-dd HH:mm:ss
refer
Refer
防盜鏈信息，詳見【Refer】描述
headers
List
Header信息集合，詳見【HeaderItem】描述
caches
List
緩存信息集合，詳見【CacheItem】描述
origins
List< OriginItem >
源站信息集合，詳見【OriginItem】描述
cert
Cert
證書信息對象，詳見【Cert】描述
【Refer】
名稱
類型
描述
refChain
String
防盜鏈類型 onVisit：白名單 offVisit：黑名單
refName
String
防盜鏈內容，域名或IP
refInclude
Integer
是否包含空Refer 0：不包含; 1：包含名單
【HeaderItem】
名稱
類型
描述
headerId
Long
Header數據唯一標識
headerKey
String
Header Key僅支持 ? Content-Disposition ? Content-Language ? Access-Control-Allow-Origin ? Access-Control-Allow-Methods ? Access-Control-Max-Age防盜鏈內容，域名或IP
headerValue
IntStringeger
當headerKey設置為“Access-Control-Allow-Origin”時，值僅能設置為 * ，或者一個域名(需要以http:// 或https://開頭)
【CacheItem】
名稱
類型
描述
cacheId
Long
緩存數據唯一標識
rType
String
緩存類型 1：文件 2：目錄
tSuffix
Integer
內容
cacheTime
Integer
緩存時間
timeUnit
String
緩存時間單位 second：秒 day： minute：分 hour：小時
【OriginItem】
名稱
類型
描述
originId
Long
源站數據唯一標識
address
String
源站地址(IP或域名)P
port
Integer
源站端口
【Cert】
名稱
類型
描述
certId
Long
證書數據唯一標識
createTime
Date
證書創建時間，格式yyyy-MM-dd HH:mm:ss
validTime
Date
證書生效時間，格式yyyy-MM-dd HH:mm:ss
返回樣例
{
"requestId": "c835098b-1ee5-4235-a1c1-e4897079e010",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 1,
"data": [
{
"domainId": 1,
"domainName": "www.xx.zhoufengjie.cn",
"icpNumber": "1113312222",
"serviceType": "web",
"cname": "www.xx.zhoufengjie.cn.org.net",
"status": "deploying",
"createTime": "2017-07-04 08:21:37",
"refer": {
"refChain": "onVisit",
"refName": "aaaa.com",
"refInclude": "0"
},
"header": [
{
"headerId": 1,
"headerKey": "Content-Language",
"headerValue": "CN"
},
{
"headerId": 2,
"headerKey": "Access-Control-Allow-Origin",
"headerValue": "http://1.com"
}
],
"cache": [
{
"cacheId": 1,
"rType": "1",
"tSuffix": "mp3/mp4",
"cacheTime": "1",
"timeUnit": "day"
},
{
"cacheId": 2,
"rType": "1",
"tSuffix": "html",
"cacheTime": "10",
"timeUnit": "day"
},
],
"origins": [
{
"originId": 1,
"address": "61.10.100.1",
"port": "80"
}
]
}
]
}
緩存配置管理接口列表
修改源站配置請求地址
http://[hostAddress]/ccsp/action/api/v3/EditOriginConfig
接口描述
修改加速域名源站配置。
請求參數
名稱
類型
必須
描述
domainName
String
是
加速域名
origin
String
是
源站設置，支持配置一個域名或多個源站IP,多源站IP地址間以;分隔，端口可配置區間 0 ~ 65535。域名模式：www.xxx.com:8080 IP模式：61.1.1.1:8080;62.2.2.2:8080
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
刪除源站配置請求地址
http://[hostAddress]/ccsp/action/api/v3/DeleteOriginConfig
接口描述
刪除加速域名源站配置。
請求參數
名稱
類型
必須
描述
originId
Long
是
源站數據唯一標識
domainName
String
是
加速域名
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
防盜鏈設置請求地址
http://[hostAddress]/ccsp/action/api/v3/SetRefer
接口描述
設置加速域名防盜鏈。
請求參數
名稱
類型
必須
描述
domainId
Long
否
加速域名唯一標識，domainName為空時，此值不能為空。
domainName
String
否
加速域名，domainId為空時，此值不能為空。
refChain
String
是
防盜鏈類型onVisit：白名單 offVisit：黑名單
refName
String
是
防盜鏈內容，域名或IP
refInclude
Integer
是
是否包含空Refer 0：不包含 1：包含
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
刪除防盜鏈請求地址
http://[hostAddress]/ccsp/action/api/v3/DeleteRefer
接口描述
刪除加速域名防盜鏈配置。
請求參數
名稱
類型
必須
描述
domainId
Long
否
加速域名唯一標識，domainName為空時，此值不能為空。
domainName
String
否
加速域名，domainId為空時，此值不能為空。
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
緩存設置請求地址
http://[hostAddress]/ccsp/action/api/v3/SetCacheConfig
接口描述
設置加速域名緩存。
請求參數
名稱
類型
必須
描述
domainId
Long
否
加速域名唯一標識，domainName為空時，此值不能為空。
domainName
String
否
加速域名，domainId為空時，此值不能為空。
rType
Integer
是
緩存類型 1：文件 2：目錄
tSuffix
String
是
內容
cacheTime
Integer
是
緩存時間
timeUnit
String
是
緩存時間單位 second：秒 day：天 minute：分hour：小時
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
修改緩存設置請求地址
http://[hostAddress]/ccsp/action/api/v3/EditCacheConfig
接口描述
修改加速域名緩存。
請求參數
名稱
類型
必須
描述
domainId
Long
否
加速域名唯一標識，domainName為空時，此值不能為空。
domainName
String
否
加速域名，domainId為空時，此值不能為空。
cacheId
Long
是
緩存數據唯一標識
rType
Integer
是
緩存類型 1：文件 2：目錄
tSuffix
String
是
內容
cacheTime
Integer
是
緩存時間
timeUnit
String
是
緩存時間單位 second：秒 day：天 minute：分hour：小時
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
刪除緩存設置請求地址
http://[hostAddress]/ccsp/action/api/v3/DeleteCacheConfig
接口描述
刪除加速域名緩存。
請求參數
名稱
類型
必須
描述
domainId
Long
否
加速域名唯一標識，domainName為空時，此值不能為空。
domainName
String
否
加速域名，domainId為空時，此值不能為空。
cacheId
Long
是
緩存數據唯一標識
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
HttpHeader設置請求地址
http://[hostAddress]/ccsp/action/api/v3/SetHttpHeaderConfig
接口描述
設置加速域名HttpHeader。
請求參數
名稱
類型
必須
描述
domainName
String
是
加速域名
headerKey
String
是
Header Key僅支持 ? Content-Disposition ? Content-Language ? Access-Control-Allow-Origin ? Access-Control-Allow-Methods ? Access-Control-Max-Age
headerValue
String
是
當headerKey設置為“Access-Control-Allow-Origin”時，值僅能設置為 * ，或者一個域名(需要以http:// 或https://開頭)
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
修改HttpHeader請求地址
http://[hostAddress]/ccsp/action/api/v3/EditHttpHeaderConfig
接口描述
修改加速域名HttpHeader。
請求參數
名稱
類型
必須
描述
domainName
String
是
加速域名
configId
Long
是
httpHeader數據唯一標識
headerKey
String
是
Header Key僅支持 ? Content-Disposition ? Content-Language ? Access-Control-Allow-Origin ? Access-Control-Allow-Methods ? Access-Control-Max-Age
headerValue
String
是
當headerKey設置為“Access-Control-Allow-Origin”時，值僅能設置為 * ，或者一個域名(需要以http:// 或https://開頭)
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
刪除HttpHeader請求地址
http://[hostAddress]/ccsp/action/api/v3/DeleteHttpHeaderConfig
接口描述
刪除加速域名HttpHeader。
請求參數
名稱
類型
必須
描述
domainName
String
否
加速域名
configId
Long
是
httpHeader數據唯一標識
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
Https證書設置請求地址
http://[hostAddress]/ccsp/action/api/v3/SetHttpsInfo
接口描述
設置加速域名Https證書。
請求參數
名稱
類型
必須
描述
domainName
String
是
加速域名
privateKey
String
是
私鑰
cert
String
是
證書
httpsType
Integer
是
配置類型 1：http 回源 2：協議跟隨回源
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
刪除Https證書請求地址
http://[hostAddress]/ccsp/action/api/v3/DeleteHttpsInfo
接口描述
刪除加速域名Https證書。
請求參數
名稱
類型
必須
描述
domainName
String
是
加速域名
返回參數
名稱
類型
必須
描述
requestId
String
是
用戶每次請求返回對應的唯一標識
httpCode
String
是
HTTP狀態碼，描述一次請求對應的HTTP狀態。
code
String
是
本次請求服務執行狀態碼，具體內容，詳見返回狀態碼小節。
message
String
是
本次請求的描述信息。
totalCount
int
否
查詢結果總數(查詢類接口用于客戶端分頁用)
data
List
否
返回的數據實體對象集合
返回樣例
{
"requestId": "971b4c4d4c7f45b9b8690fb88cb65bf5",
"httpCode": "200",
"code": "success",
"message": "success",
"totalCount": 0,
"data": []
}
刷新預熱接口列表
緩存批量刷新請求地址
http://[hostAddress]/ccsp/action/api/v3/CreateRefreshTask
接口描述
創建Cache緩存刷新任務，支持批量URL刷新和目錄刷新。每次任務創建成功后返回本次任務標識和提交失敗的URL數據。
請求參數
名稱
類型
必須
描述
url
String
是
URL列表，支持多URL，以英文逗號”,”分隔，刷新任務單次最多支持1000個URL，目錄方式刷新任務時，限制每天只能刷新100個目錄
taskType
int
是
任務刷新方式，0:URL刷新；1：目錄刷新
返回參數
名稱
類型
描述
taskId
String
任務標識
failUrl
String
不合法的URL列表，以英文逗號”,”分隔
返回樣例
{
"requestId": "f2c84d9a-aa0d-487e-8a5d-24f93cd7d258",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 1,
"data": [
{
"taskId": "148237248263205634",
"failUrl": "http://xxx/3.jpg,http://xxx/2.jpg"
}
]
}
刷新任務結果查詢請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeRefreshTask
接口描述
查詢Cache緩存刷新任務結果。
請求參數
名稱
類型
必須
描述
taskId
String
是
任務標識
url
String
否
URL
返回參數
名稱
類型
描述
taskId
String
任務標識
url
String
URL
status
int
狀態，0：等待中；1：處理中；2：成功；3：失敗
taskType
int
任務刷新方式，0:URL刷新；1：目錄刷新
返回樣例
{
"requestId": "48e7ca59-7a54-48a9-a597-4bf96bea582a",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 3,
"data": [
{
"taskId": "148237143539484309",
"url": "http://www.zhouds.cn/3.jpg",
"status": 3,
"taskType": 0
},
{
"taskId": "148237143539484309",
"url": "http://www.zhouds.cn/2.jpg",
"status": 3,
"taskType": 0
},
{
"taskId": "148237143539484309",
"url": "http://www.zhouds.cn/1.jpg",
"status": 3,
"taskType": 0
}
]
}
緩存預熱請求地址
http://[hostAddress]/ccsp/action/api/v3/createPreload
接口描述
創建Cache緩存預熱任務，支持批量URL預熱。每次任務創建成功后返回本次任務標識和失敗描述。
請求參數
名稱
類型
必須
描述
publishUrls
String
是
URL列表，支持多URL，以英文逗號”,”分隔，預熱任務單次最多支持100個URL
返回參數
名稱
類型
描述
taskId
String
任務標識
msg
String
失敗描述
返回樣例
{
"requestId": "f2c84d9a-aa0d-487e-8a5d-24f93cd7d258",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 1,
"data": [
{
"taskId": "148237248263205634",
"msg": "http://xxx/3.jpg,http://xxx/2.jpg"
}
]
}
預熱任務查詢請求地址
http://[hostAddress]/ccsp/action/api/v3/preloadQuery
接口描述
查詢Cache緩存預熱任務結果。
請求參數
名稱
類型
必須
描述
taskId
String
是
任務標識
返回參數
名稱
類型
描述
taskId
String
任務標識
status
String
任務當前狀態，0：成功；1：進行中； 2：失敗
msg
String
失敗描述
返回樣例
{
"requestId": "48e7ca59-7a54-48a9-a597-4bf96bea582a",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 1,
"data": [
{
"taskId": "148237248263205634",
"status": 1,
"msg": ""
}
]
}
數據查詢接口列表
命中流量統計請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeCacheHitFlux
接口描述
查詢命中流量信息，參數中的查詢條件間為AND關系。默認以5分鐘緯度分組聚合數據，返回聚合后的命中流量數據。
請求參數
名稱
類型
必須
描述
domain
String
是
頻道列表，支持多頻道，以英文逗號”,”分隔，最多支持10個頻道同時查詢
startTime
Date
是
數據范圍開始時間，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為7 天
endTime
Date
是
數據范圍結束時間，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為7 天
返回參數
名稱
類型
描述
time
Date
時間,格式yyyyMMddHHmm
flux
Long
命中流量，單位Byte
返回樣例
{
"requestId": "1b234d37-e051-44cc-bea2-9fed665382ad",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 3,
"data": [
{
"time": "201804121450",
"flux": 14608275484
},
{
"time": "201804121500",
"flux": 24403363124
},
{
"time": "201804121455",
"flux": 14898737789
}
]
}
命中請求數統計請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeCacheHitNum
接口描述
查詢命中請求數信息，參數中的查詢條件間為AND關系。默認以5分鐘緯度分組聚合數據，返回聚合后的命中請求數數據。
請求參數
名稱
類型
必須
描述
domain
String
是
頻道列表，支持多頻道，以英文逗號”,”分隔，最多支持10個頻道同時查詢
startTime
Date
是
數據范圍開始時間，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為7 天
endTime
Date
是
數據范圍結束時間，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為7 天
返回參數
名稱
類型
描述
time
Date
時間,格式yyyyMMddHHmm
count
Long
命中次數
返回樣例
{
"requestId": "5dc54e2a-4801-4d87-bf5c-58fc5d687457",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 3,
"data": [
{
"time": "201804121450",
"count": 8332
},
{
"time": "201804121500",
"count": 16387
},
{
"time": "201804121455",
"count": 10715
}
]
}
狀態碼請求數統計請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeHttpCode
接口描述
查詢http狀態碼信息，參數中的查詢條件間為AND關系。默認以5分鐘緯度分組聚合數據，返回聚合后的數據。
請求參數
名稱
類型
必須
描述
domains
String
是
頻道列表，支持多頻道，以英文逗號”,”分隔，最多支持10個頻道同時查詢
startTime
Date
是
數據范圍開始時間，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為7 天
endTime
Date
是
數據范圍結束時間，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為7 天
返回參數
名稱
類型
描述
httpCode
Long
http狀態碼
codeData
List
狀態碼對象集合，見【Item】描述
【Item】
名稱
類型
描述
time
String
時間,格式yyyyMMddHHmm
count
Long
狀態碼數量
返回樣例
{
"requestId": "1b0cb068-9359-4d7b-a3e0-83fd12801975",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 11,
"data": [
{
"httpCode": "416",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "405",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "302",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "404",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "304",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "200",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "401",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "403",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "206",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "502",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
},
{
"httpCode": "500",
"codeData": [
{
"time": "201804121250",
"count": 0
},
{
"time": "201804121300",
"count": 0
},
{
"time": "201804121255",
"count": 0
}
]
}
]
}
帶寬統計請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeBandwidth
接口描述
查詢帶寬數據。
請求參數
名稱
類型
必須
描述
domain
String
是
頻道列表，支持多頻道，以英文逗號”,”分隔，最多支持10個頻道同時查詢
startDate
String
是
數據范圍開始日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
startDate
String
是
數據范圍結束日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
返回參數
名稱
類型
描述
time
String
統計時間點
bandwidth
String
帶寬值. 單位為 bps
返回樣例
{
"requestId": "ab9220ca-9d01-44d0-bade-fab9139f4d3c",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 3,
"data": [
{
"time": "2018-04-13 00:00:00",
"bandwidth": “123456”
},
{
"time": "2018-04-13 00:05:00",
"bandwidth": “123456”
}
]
}
流量統計請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeFlux
接口描述
查詢流量數據。
請求參數
名稱
類型
必須
描述
domain
String
是
頻道列表，支持多頻道，以英文逗號”,”分隔，最多支持10個頻道同時查詢
startDate
String
是
數據范圍開始日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
endDate
String
是
數據范圍結束日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
返回參數
名稱
類型
描述
time
String
時間點
flux
String
帶寬值, 單位為 byte
返回樣例
{
"requestId": "ab9220ca-9d01-44d0-bade-fab9139f4d3c",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 3,
"data": [
{
"time": "2018-04-13 00:00:00",
"flux": “123456”
},
{
"time": "2018-04-13 00:05:00",
"flux ": “123456”
}
]
}
請求數統計請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeVisitor
接口描述
查詢請求數數據。
請求參數
名稱
類型
必須
描述
domain
String
是
頻道列表，支持多頻道，以英文逗號”,”分隔，最多支持10個頻道同時查詢
startDate
String
是
數據范圍開始日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
endDate
String
是
數據范圍結束日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
返回參數
名稱
類型
描述
time
String
統計時間點
pv
String
請求數量
返回樣例
{
"requestId": "ab9220ca-9d01-44d0-bade-fab9139f4d3c",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 3,
"data": [
{
"time": "2018-04-13 00:00:00",
"pv": “123456”
},
{
"time": "2018-04-13 00:05:00",
"pv": “123456”
}
]
}
回源帶寬統計請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeOriginBandwidth
接口描述
查詢回源帶寬數據。
請求參數
名稱
類型
必須
描述
domain
String
是
頻道列表，支持多頻道，以英文逗號”,”分隔，最多支持5個頻道同時查詢
startDate
String
是
數據范圍開始日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
endDate
String
是
數據范圍結束日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
返回參數
名稱
類型
描述
time
String
統計時間點
bandwidth
String
回源帶寬值, 單位為 bps
返回樣例
{
"requestId": "ab9220ca-9d01-44d0-bade-fab9139f4d3c",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 3,
"data": [
{
"time": "2018-04-13 00:00:00",
"bandwidth": “123456”
},
{
"time": "2018-04-13 00:05:00",
"bandwidth": “123456”
}
]
}
回源流量統計請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeOriginFlux
接口描述
查詢回源流量數據。
請求參數
名稱
類型
必須
描述
domain
String
是
頻道列表，支持多頻道，以英文逗號”,”分隔，最多支持5個頻道同時查詢
startDate
String
是
數據范圍開始日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
endDate
String
是
數據范圍結束日期，格式yyyy-MM-dd HH:mm:ss，開始時間和結束時間范圍上限為90 天
返回參數
名稱
類型
描述
time
String
統計時間點
failUrl
String
回源流量值, 單位為 byte
返回樣例
{
"requestId": "ab9220ca-9d01-44d0-bade-fab9139f4d3c",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 3,
"data": [
{
"time": "2018-04-13 00:00:00",
"flux": “123456”
},
{
"time": "2018-04-13 00:05:00",
"flux": “123456”
}
]
}
日志下載請求地址
http://[hostAddress]/ccsp/action/api/v3/DescribeDownloadLog
接口描述
查詢日志文件列表信息，參數中的查詢條件間為AND關系。
請求參數
名稱
類型
必須
描述
domain
String
是
U頻道列表，支持多頻道，以英文逗號”,”分隔，最多支持10個頻道同時查詢
day
Date
是
日期，格式yyyy-MM-dd
返回參數
名稱
類型
描述
createTime
Date
文件創建時間，格式yyyy-MM-dd HH:mm:ss
fileName
String
文件名稱，格式_.gz
fileLength
Float
文件大小，單位MB，四舍五入保留兩位小數
返回樣例
{
"requestId": "01d7d86c-dd74-416e-8ee0-e17d86ea2108",
"httpCode": "200",
"code": "Success",
"message": "Success",
"totalCount": 2,
"data": [
{
"createTime": "2016-12-01 01:14:13",
"fileName": "test.zhouds.cn_20161130.gz",
"fileLength": "0.42",
"downloadPath": "http://xxx/ccsp/action/api/downloadLog?clusterServerIp=xx.10.10.xx&day=20170227&fileName=xxx.com_20170227010000.gz"
},
{
"createTime": "2016-12-01 01:14:13",
"fileName": "www.zhouds.cn_20161130.gz",
"fileLength": "0.42",
"downloadPath": "http://xxx/ccsp/action/api/downloadLog?clusterServerIp=xx.10.10.xx&day=20170227&fileName=xxx.com_20170227010000.gz"
}
]
}
總結
以上是生活随笔為你收集整理的nga能查服务器状态吗,NGAA的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 图形工作站计算机大全,图形工作站价格怎么
- 下一篇： 同方自主可控系统服务器,自主可控 同方