如何使用CloudMonitor服務API或SDK查詢OSS監控資料 - Object Storage Service

OSS監控服務為您提供系統基本運行狀態、效能以及計量等方面的監控資料指標，協助您跟蹤請求、分析使用方式、統計業務趨勢，及時發現以及診斷系統的相關問題。本文介紹如何使用CloudMonitor服務提供的API或SDK查詢OSS監控資料。

說明

CloudMonitor服務SDK樣本，請參見SDK參考。

Space

Space用於指定監控的雲端服務。OSS監控服務使用的Namespace為acs_oss_dashboard。

例如，通過Java SDK指定監控OSS服務的範例程式碼如下：

DescribeMetricListRequest request = new DescribeMetricListRequest();
request.setNamespace("acs_oss_dashboard");

StartTime和EndTime

StartTime和EndTime用於指定查詢監控資料的時間範圍。CloudMonitor的時間參數取值範圍採用左開右閉的形式(StartTime, EndTime]，即可以查詢StartTime到EndTime之間的資料（包含EndTime的資料）。StartTime和EndTime的時間間隔不能大於31天，且無法查詢31天以前的資料。

例如，通過Java SDK指定查詢監控資料時間範圍的範例程式碼如下：

//設定監控資料的結束時間。
request.setEndTime("2019-05-13 11:06:27");
//設定監控資料的開始時間。
request.setStartTime("2019-05-13 10:20:27");

Dimensions

Dimensions用於指定待查詢的Bucket。不指定Dimensions時，表示查詢帳號層級下各個Bucket的指標資料。層級說明請參見Metric。

例如，通過Java SDK查詢Bucket資料的範例程式碼如下：

//指定待查詢資料的Bucket名稱。
request.setDimensions("{\"BucketName\":\"<yourBucketName>\"}");

Period

Period用於指定指標項的查詢周期。OSS監控的計量類指標查詢周期為3600s，其他所有指標的查詢周期均為60s。各指標項的說明，請參見Metric。

例如，通過Java SDK監控某個非計量類指標的範例程式碼如下：

request.setPeriod("60");

Metric

Metric用於指定查詢的指標。Metric分為非計量類以及計量類指標。Java SDK程式碼範例如下：

//設定Metric名稱。
request.setMetric("<MetricName>");

說明

您可以訪問CloudMonitor指標，查看OSS的所有指標資訊。

非計量類指標

非計量類指標僅用於統計監控資料。

層級	Metric	對應指標項名稱	單位
使用者層級	UserAvailability	可用性	%
	UserRequestValidRate	有效請求率	%
	UserTotalRequestCount	總請求數	次數
	UserValidRequestCount	有效請求數	次數
	UserInternetSend	公網流出流量	位元組
	UserInternetRecv	公網流入流量	位元組
	UserIntranetSend	內網流出流量	位元組
	UserIntranetRecv	內網流入流量	位元組
	UserCdnSend	CDN流出流量	位元組
	UserCdnRecv	CDN流入流量	位元組
	UserSyncSend	跨地區複製流出流量	位元組
	UserSyncRecv	跨地區複製流入流量	位元組
	UserServerErrorCount	服務端錯誤請求總數	次數
	UserServerErrorRate	服務端錯誤請求佔比	%
	UserNetworkErrorCount	網路錯誤請求總數	次數
	UserNetworkErrorRate	網路錯誤請求佔比	%
	UserAuthorizationErrorCount	用戶端授權錯誤請求總數	次數
	UserAuthorizationErrorRate	用戶端授權錯誤請求佔比	%
	UserResourceNotFoundErrorCount	用戶端資源不存在錯誤請求總數	次數
	UserResourceNotFoundErrorRate	用戶端資源不存在錯誤請求佔比	%
	UserClientTimeoutErrorCount	用戶端逾時錯誤請求總數	次數
	UserClientOtherErrorRate	用戶端逾時錯誤請求佔比	%
	UserClientOtherErrorCount	用戶端其他錯誤請求總數	次數
	UserClientOtherErrorRate	用戶端其他錯誤請求佔比	%
	UserSuccessCount	成功請求總數	次數
	UserSuccessRate	成功請求佔比	%
	UserRedirectCount	重新導向請求總數	次數
	UserRedirectRate	重新導向請求佔比	%
Bucket層級	Availability	可用性	%
	RequestValidRate	有效請求率	%
	TotalRequestCount	總請求數	次數
	ValidRequestCount	有效請求數	次數
	InternetSend	公網流出流量	位元組
	InternetRecv	公網流入流量	位元組
	IntranetSend	內網流出流量	位元組
	IntranetRecv	內網流入流量	位元組
	InternetSendBandwidth	公網流出頻寬	bps
	InternetRecvBandwidth	公網流入頻寬	bps
	IntranetSendBandwidth	內網流出頻寬	bps
	IntranetRecvBandwidth	內網流入頻寬	bps
	CdnSend	CDN流出流量	位元組
	CdnRecv	CDN流入流量	位元組
	SyncSend	跨地區複製流出流量	位元組
	SyncRecv	跨地區複製流入流量	位元組
	ServerErrorCount	服務端錯誤請求總數	次數
	ServerErrorRate	服務端錯誤請求佔比	%
	NetworkErrorCount	網路錯誤請求總數	次數
	NetworkErrorRate	網路錯誤請求佔比	%
	AuthorizationErrorCount	用戶端授權錯誤請求總數	次數
	AuthorizationErrorRate	用戶端授權錯誤請求佔比	%
	ResourceNotFoundErrorCount	用戶端資源不存在錯誤請求總數	次數
	ResourceNotFoundErrorRate	用戶端資源不存在錯誤請求佔比	%
	ClientTimeoutErrorCount	用戶端逾時錯誤請求總數	次數
	ClientTimeoutErrorRate	用戶端逾時錯誤請求佔比	%
	ClientOtherErrorCount	用戶端其他錯誤請求總數	次數
	ClientOtherErrorRate	用戶端其他錯誤請求佔比	%
	SuccessCount	成功請求總數	次數
	SuccessRate	成功請求佔比	%
	RedirectCount	重新導向請求總數	次數
	RedirectRate	重新導向請求佔比	%
	GetObjectE2eLatency	GetObject請求平均E2E延時	毫秒
	GetObjectServerLatency	GetObject請求平均伺服器延時	毫秒
	MaxGetObjectE2eLatency	GetObject請求最大E2E延時	毫秒
	MaxGetObjectServerLatency	GetObject請求最大伺服器延時	毫秒
	HeadObjectE2eLatency	HeadObject請求平均E2E延時	毫秒
	HeadObjectServerLatency	HeadObject請求平均伺服器延時	毫秒
	MaxHeadObjectE2eLatency	HeadObject請求最大E2E延時	毫秒
	MaxHeadObjectServerLatency	HeadObject請求最大伺服器延時	毫秒
	PutObjectE2eLatency	PutObject請求平均E2E延時	毫秒
	PutObjectServerLatency	PutObject請求平均伺服器延時	毫秒
	MaxPutObjectE2eLatency	PutObject請求最大E2E延時	毫秒
	MaxPutObjectServerLatency	PutObject請求最大伺服器延時	毫秒
	PostObjectE2eLatency	PostObject請求平均E2E延時	毫秒
	PostObjectServerLatency	PostObject請求平均伺服器延時	毫秒
	MaxPostObjectE2eLatency	PostObject請求最大E2E延時	毫秒
	MaxPostObjectServerLatency	PostObject請求最大伺服器延時	毫秒
	AppendObjectE2eLatency	AppendObject請求平均E2E延時	毫秒
	AppendObjectServerLatency	AppendObject請求平均伺服器延時	毫秒
	MaxAppendObjectE2eLatency	AppendObject請求最大E2E延時	毫秒
	MaxAppendObjectServerLatency	AppendObject請求最大伺服器延時	毫秒
	UploadPartE2eLatency	UploadPart請求平均E2E延時	毫秒
	UploadPartServerLatency	UploadPart請求平均伺服器延時	毫秒
	MaxUploadPartE2eLatency	UploadPart請求最大E2E延時	毫秒
	MaxUploadPartServerLatency	UploadPart請求最大伺服器延時	毫秒
	UploadPartCopyE2eLatency	UploadPartCopy請求平均E2E延時	毫秒
	UploadPartCopyServerLatency	UploadPartCopy請求平均伺服器延時	毫秒
	MaxUploadPartCopyE2eLatency	UploadPartCopy請求最大E2E延時	毫秒
	MaxUploadPartCopyServerLatency	UploadPartCopy請求最大伺服器延時	毫秒
	GetObjectCount	GetObject成功請求數	次數
	HeadObjectCount	HeadObject成功請求數	次數
	PutObjectCount	PutObject成功請求數	次數
	PostObjectCount	PostObject成功請求數	次數
AppendObjectCount	AppendObject成功請求數	次數
UploadPartCount	UploadPart成功請求數	次數
UploadPartCopyCount	UploadPartCopy成功請求數	次數
DeleteObjectCount	DeleteObject成功請求數	次數
DeleteObjectsCount	DeleteObjects成功請求數	次數
MirrorTraffic	指定回源來源站點的正常請求流入流量	位元組
MirrorTrafficByStatus	指定傳回值和回源來源站點的請求流入流量	位元組
MirrorRequestTransferSpeed	指定回源來源站點的正常請求平均傳輸速度	位元組/秒
MirrorRequestTransferSpeedByStatus	指定傳回值和回源來源站點的請求平均傳輸速度	位元組/秒
MirrorRequestCount	指定回源來源站點的正常請求總數	次數
MirrorRequestCountByStatus	指定傳回值和回源來源站點的請求總數	次數
MirrorAverageLatency	指定回源來源站點的正常請求平均延時	毫秒
MirrorAverageLatencyByStatus	指定傳回值和回源來源站點的請求平均延時	毫秒
MirrorRequestStatusRatio	指定回源來源站點的狀態代碼2xx、3xx、4xx、5xx所佔總請求量的百分比	%
MirrorRequestStatusCount	指定回源來源站點的狀態代碼2xx、3xx、4xx、5xx的請求數量	次數

計量類指標

查詢以下Metric時如果指定了Dimensions，則表示查詢的是指定Bucket的資料。如果未指定Dimensions，則表示查詢帳號層級下各個Bucket的資料。

說明

為了與計費策略保持統一，計量指標的收集和展示存在一定的特殊性。更多資訊，請參見計量指標相關說明。

Metric	對應指標項名稱	單位
MeteringStorageUtilization	儲存大小	位元組
MeteringGetRequest	Get類請求數	次數
MeteringPutRequest	Put類請求數	次數
MeteringInternetTX	公網流出計量流量	位元組
MeteringCdnTX	CDN流出計量流量	位元組
MeteringSyncRX	跨地區複製流入計量流量	位元組