文档简介:
GetCapacity
此操作用来查询用户的容量。
请求参数
名称 |
描述 |
是否必填 |
Action |
GetCapacity。 |
是 |
BeginDate |
指定查询容量的起始时间,统计数据的起始时间为开始日期(时区为:UTC+8)的00:00。 类型:Time。 取值:格式为yyyy-MM-dd。 |
是 |
EndDate |
指定查询容量的结束时间,返回数据的时间为结束日期(时区为:UTC+8)的最后一个数据。 类型:Time。 取值:格式为yyyy-MM-dd。EndDate不能早于BeginDate。 说明: l Freq=by5min,EndDate与BeginDate的间隔不大于1天; l Freq=byHour,EndDate与BeginDate的间隔不大于7天; l Freq=byDay,EndDate与BeginDate的间隔不大于30天。 |
是 |
Bucket |
指定查询容量的Bucket名称,如果不指定Bucket名称,则表示查询账户下所有Bucket的容量之和。 类型:字符串。 取值:3~63位字符串,只能由小写字母、数字、短横线(-)和点(.)组成。 |
否 |
StorageClass |
指定查询的存储类型。 类型:Enum。 取值: l ALL:所有存储类型; l STANDARD:标准存储; l STANDARD_IA:低频访问存储。 默认值为STANDARD。 |
否 |
Region |
指定查询容量的数据位置,如果不指定数据位置名称,则查询账户名下所有数据位置的容量之和。 类型:字符串。 取值:ZhengZhou、ShenYang、ChengDu、WuLuMuQi、LanZhou、QingDao、GuiYang、LaSa、WuHu、WuHan、ShenZhen、SH2、SuZhou。 |
否 |
Freq |
指定返回统计数据的采样粒度。 类型:Enum。 取值: l by5min:统计数据的采样粒度为5分钟; l byHour:统计数据的采样粒度为1小时; l byDay:统计数据的采样粒度为1天。 默认值为byHour。 |
否 |
l 响应结果
名称 |
描述 |
Account |
发出请求的账户名。 |
UserName |
发出请求的用户名。如果根用户发送的该请求,则UserName为root。 |
StorageClass |
存储类型: l ALL:所有存储; l STANDARD:标准存储; l STANDARD_IA:低频访问存储。 |
TimeZone |
返回数据的时区,统一为UTC +0800。 |
Freq |
统计数据的采样粒度: l by5min:统计数据的采样粒度为5分钟; l byHour:统计数据的采样粒度为1小时; l byDay:统计数据的采样粒度为1天。 |
BucketName |
Bucket名字。如果用户在请求中没有携带Bucket参数,BucketName为空。 |
RegionName |
数据位置,如果用户在请求中没有携带Region参数,RegionName为空。 |
Statistics.Date |
返回结果对应的时间: l 当请求参数Freq为by5min或byHour时,返回格式为yyyy-MM-dd HH:mm; l 当请求参数Freq为byDay时,返回格式为yyyy-MM-dd。 |
Statistics.Data.MaxCapacity |
标准存储数据的容量峰值,单位是Byte。 如果Freq值为by5min,该字段值显示为空。 |
Statistics.Data.AverageCapacity |
标准存储数据的容量平均值,单位是Byte。 如果Freq值为by5min,该字段值显示为空。 |
Statistics.Data.SampleCapacity |
标准存储数据的实时容量值,单位是Byte。 |
Statistics.Standard_ia.MaxCapacity |
低频访问存储数据的容量峰值,单位是Byte。 如果Freq值为by5min,该字段值显示为空。 |
Statistics.Standard_ia.AverageCapacity |
低频访问存储数据的容量平均值,单位是Byte。 如果Freq值为by5min,该字段值显示为空。 |
Statistics.Standard_ia.SampleCapacity |
低频访问存储数据的实时容量值,单位是Byte。 |
l 请求示例
按小时(byHour)查询Bucket为lt-bucket1、数据位置为ZhengZhou、2019-10-15至2019-10-16标准存储数据的容量
GET /?Action=GetCapacity&BeginDate=2019-10-15&EndDate=2019-10-16&StorageClass=STANDARD&Bucket=lt-bucket1&Freq=byHour&Region=ZhengZhou HTTP/1.1 Date: Wed, 16 Oct 2019 06:24:41 GMT Authorization: AWS 7799e793ce4624ee7e5a:fgiFELJ9zZTJ+MEfausUlFMCCAk= Host: oos-cn-mg.ctyunapi.cn |
l 返回示例
HTTP/1.1 200 OK Date: Wed, 16 Oct 2019 06:28:23 GMT x-amz-request-id: 35560988c43e46d9 Content-Type: application/xml; charset=utf-8 Content-Length: 268 Server: CTYUN
<?xml version="1.0" encoding="UTF-8"?> <GetCapacityResponse> <Account>test@oos.cn</Account> <UserName>user_test1</UserName> <StorageClass>STANDARD</StorageClass> <TimeZone>UTC +0800</TimeZone> <Freq>byHour</Freq> <BucketName>lt-bucket1</BucketName> <RegionName>ZhengZhou</RegionName> <Statistics> <Date>2019-10-15 00:00</Date> <Data> <MaxCapacity>10001</MaxCapacity> <AverageCapacity>10001</AverageCapacity> <SampleCapacity>10001</SampleCapacity> </Data> </Statistics> <Statistics> ... </Statistics> </GetCapacityResponse> |