OSS监控数据访问指南

本章内容为OpenAPI（或者云监控提供的SDK）查询OSS监控服务指标数据的使用提供相关参数依据。

关于Project


OSS监控服务指标项的数据都使用相同的Project名称：acs_oss。
使用JAVA SDK设置代码示例如下：

1. [backcolor=transparent]QueryMetricRequest[backcolor=transparent] request [backcolor=transparent]=[backcolor=transparent] [backcolor=transparent]new[backcolor=transparent] [backcolor=transparent]QueryMetricRequest[backcolor=transparent]();
2. [backcolor=transparent]request[backcolor=transparent].[backcolor=transparent]setProject[backcolor=transparent]([backcolor=transparent]"acs_oss"[backcolor=transparent]);

关于StartTime和EndTime


云监控的时间参数取值范围采用左开右闭的形式，即(StartTime, EndTime]，处于边界StartTime的数据不会被获取，而处于边界EndTime的数据会被查询到。
另外，云监控数据保留时间为31天，设置的StartTime和EndTime的时间间距不能大于31天，并且不能够查询31天以前的数据。
其他时间参数信息详见 云监控API接口说明。
使用JAVA SDK设置代码示例如下：

1. [backcolor=transparent]request[backcolor=transparent].[backcolor=transparent]setStartTime[backcolor=transparent]([backcolor=transparent]"2016-05-15 08:00:00"[backcolor=transparent]);
2. [backcolor=transparent]request[backcolor=transparent].[backcolor=transparent]setEndTime[backcolor=transparent]([backcolor=transparent]"2015-05-15 09:00:00"[backcolor=transparent]);

关于Dimensions


OSS监控服务根据用户使用场景，将监控项分为用户和Bucket两个不同的层级进行监控。针对不同的层级监控数据的访问，Dimensions不同:

• 用户层级数据不需要设置Dimensions。
• 
  Bucket层级数据的Dimensions设置为：
  1. [backcolor=transparent]   [backcolor=transparent] {[backcolor=transparent] "BucketName"[backcolor=transparent] :[backcolor=transparent] [backcolor=transparent] "your_bucket_name"[backcolor=transparent] }

其中，your_bucket_name为属于该用户的某个需要查询的Bucket名称。
注意，Dimenisons是一个JSON字符串，OSS监控指标的Dimensions只有一对Key-Value。
使用JAVA SDK设置代码示例如下：

1. [backcolor=transparent]request[backcolor=transparent].[backcolor=transparent]setDimensions[backcolor=transparent]([backcolor=transparent]"{\"BucketName\":\"your_bucket_name\"}"[backcolor=transparent]);

关于Period


OSS监控指标除了计量指标，其他所有的指标的聚合粒度均为60s。计量指标的聚合粒度为3600s。
使用JAVA SDK设置代码示例如下：

1. [backcolor=transparent]   request[backcolor=transparent].[backcolor=transparent]setPeriod[backcolor=transparent]([backcolor=transparent]"60"[backcolor=transparent]);

关于Metric


OSS监控指标参考手册(OSS监控指标参考手册.md)中详细介绍的各项指标项，对应的Metric名称和层级如下表所示：

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	用户层级重定向请求占比	%	用户层级
Availability	可用性	%	Bucket层级
RequestValidRate	有效请求率	%	Bucket层级
TotalRequestCount	总请求数	次数	Bucket层级
ValidRequestCount	有效请求数	次数	Bucket层级
InternetSend	公网流出流量	字节	Bucket层级
InternetRecv	公网流入流量	字节	Bucket层级
IntranetSend	内网流出流量	字节	Bucket层级
IntranetRecv	内网流入流量	字节	Bucket层级
CdnSend	cdn流出流量	字节	Bucket层级
CdnRecv	cdn流入流量	字节	Bucket层级
SyncSend	跨区域复制流出流量	字节	Bucket层级
SyncRecv	跨区域复制流入流量	字节	Bucket层级
ServerErrorCount	服务端错误请求总数	次数	Bucket层级
ServerErrorRate	服务端错误请求占比	%	Bucket层级
NetworkErrorCount	网络错误请求总数	次数	Bucket层级
NetworkErrorRate	网络错误请求占比	%	Bucket层级
AuthorizationErrorCount	客户端授权错误请求总数	次数	Bucket层级
AuthorizationErrorRate	客户端授权错误请求占比	%	Bucket层级
ResourceNotFoundErrorCount	客户端资源不存在错误请求总数	次数	Bucket层级
ResourceNotFoundErrorRate	客户端资源不存在错误请求占比	%	Bucket层级
ClientTimeoutErrorCount	客户端超时错误请求总数	次数	Bucket层级
ClientOtherErrorRate	客户端超时错误请求占比	%	Bucket层级
ClientOtherErrorCount	客户端其他错误请求总数	次数	Bucket层级
ClientOtherErrorRate	客户端其他错误请求占比	%	Bucket层级
SuccessCount	成功请求总数	次数	Bucket层级
SuccessRate	成功请求占比	%	Bucket层级
RedirectCount	重定向请求总数	次数	Bucket层级
RedirectRate	重定向请求占比	%	Bucket层级
GetObjectE2eLatency	GetObject请求平均E2E延时	毫秒	Bucket层级
GetObjectServerLatency	GetObject请求平均服务器延时	毫秒	Bucket层级
MaxGetObjectE2eLatency	GetObject请求最大E2E延时	毫秒	Bucket层级
MaxGetObjectServerLatency	GetObject请求最大服务器延时	毫秒	Bucket层级
HeadObjectE2eLatency	HeadObject请求平均E2E延时	毫秒	Bucket层级
HeadObjectServerLatency	HeadObject请求平均服务器延时	毫秒	Bucket层级
MaxHeadObjectE2eLatency	HeadObject请求最大E2E延时	毫秒	Bucket层级
MaxHeadObjectServerLatency	HeadObject请求最大服务器延时	毫秒	Bucket层级
PutObjectE2eLatency	PutObject请求平均E2E延时	毫秒	Bucket层级
PutObjectServerLatency	PutObject请求平均服务器延时	毫秒	Bucket层级
MaxPutObjectE2eLatency	PutObject请求最大E2E延时	毫秒	Bucket层级
MaxPutObjectServerLatency	PutObject请求最大服务器延时	毫秒	Bucket层级
PostObjectE2eLatency	PostObject请求平均E2E延时	毫秒	Bucket层级
PostObjectServerLatency	PostObject请求平均服务器延时	毫秒	Bucket层级
MaxPostObjectE2eLatency	PostObject请求最大E2E延时	毫秒	Bucket层级
MaxPostObjectServerLatency	PostObject请求最大服务器延时	毫秒	Bucket层级
AppendObjectE2eLatency	AppendObject请求平均E2E延时	毫秒	Bucket层级
AppendObjectServerLatency	AppendObject请求平均服务器延时	毫秒	Bucket层级
MaxAppendObjectE2eLatency	AppendObject请求最大E2E延时	毫秒	Bucket层级
MaxAppendObjectServerLatency	AppendObject请求最大服务器延时	毫秒	Bucket层级
UploadPartE2eLatency	UploadPart请求平均E2E延时	毫秒	Bucket层级
UploadPartServerLatency	UploadPart请求平均服务器延时	毫秒	Bucket层级
MaxUploadPartE2eLatency	UploadPart请求最大E2E延时	毫秒	Bucket层级
MaxUploadPartServerLatency	UploadPart请求最大服务器延时	毫秒	Bucket层级
UploadPartCopyE2eLatency	UploadPartCopy请求平均E2E延时	毫秒	Bucket层级
UploadPartCopyServerLatency	UploadPartCopy请求平均服务器延时	毫秒	Bucket层级
MaxUploadPartCopyE2eLatency	UploadPartCopy请求最大E2E延时	毫秒	Bucket层级
MaxUploadPartCopyServerLatency	UploadPartCopy请求最大服务器延时	毫秒	Bucket层级
GetObjectCount	GetObject成功请求数	次数	Bucket层级
HeadObjectCount	HeadObject成功请求数	次数	Bucket层级
PutObjectCount	PutObject成功请求数	次数	Bucket层级
PostObjectCount	PostObject成功请求数	次数	Bucket层级
AppendObjectCount	AppendObject成功请求数	次数	Bucket层级
UploadPartCount	UploadPart成功请求数	次数	Bucket层级
UploadPartCopyCount	UploadPartCopy成功请求数	次数	Bucket层级
DeleteObjectCount	DeleteObject成功请求数	次数	Bucket层级
DeleteObjectsCount	DeleteObjects成功请求数	次数	Bucket层级

计量类指标的Metric如下，注意聚合粒度为3600s。

Metric	对应指标项名称	单位	层级
MeteringStorageUtilization	存储大小	字节	若设置Dimensions，则为Bucket层级；如果不设置，那么返回的指标为整个用户层级数据
MeteringGetRequest	Get类请求数	次数	若设置Dimensions，则为Bucket层级；如果不设置，那么返回的指标为整个用户层级数据
MeteringPutRequest	Put类请求数	次数	若设置Dimensions，则为Bucket层级；如果不设置，那么返回的指标为整个用户层级数据
MeteringInternetTX	公网流出计量流量	字节	若设置Dimensions，则为Bucket层级；如果不设置，那么返回的指标为整个用户层级数据
Metering CdnTX	cdn流出计量流量	字节	若设置Dimensions，则为Bucket层级；如果不设置，那么返回的指标为整个用户层级数据
MeteringSyncRX	跨区域复制流入计量流量	字节	若设置Dimensions，则为Bucket层级；如果不设置，那么返回的指标为整个用户层级数据

使用JAVA SDK设置代码示例如下：

1. [backcolor=transparent]   request[backcolor=transparent].[backcolor=transparent]setMetric[backcolor=transparent]([backcolor=transparent]"UserAvailability"[backcolor=transparent]);