调用DescribeVsDomainRegionData获取域名区域数据_视图计算(VECS)-阿里云帮助中心

获取域名区域数据。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vs:DescribeVsDomainRegionData	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	否	视图计算域名名称	example.aliyundoc.com
StartTime	string	否	获取数据起始时间点，日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ 最小数据粒度为 5 分钟不写默认读取过去 24 小时数据	2021-10-30T16:00:00Z
EndTime	string	否	结束时间需大于起始时间；获日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ	2021-10-31T15:59:59Z

返回参数

名称	类型	描述	示例值
	object
EndTime	string	结束时间	2021-10-31T15:59:59Z
StartTime	string	开始时间	2021-10-30T16:00:00Z
RequestId	string	请求 ID	BEA5625F-8FCF-48F4-851B-CA63946DA664
DomainName	string	视图计算域名名称	example.aliyundoc.com
DataInterval	string	时间间隔。	3600
Value	array<object>	数据。
RegionProportionData	object	数据。
TotalQuery	string	总请求次数	3
TotalBytes	string	总流量	2400057
AvgResponseRate	string	平均响应速度，单位：byte/秒	154.3345765545624
AvgResponseTime	string	平均响应时间，单位：毫秒。	5183.666666666667
ReqErrRate	string	请求错误率，例如返回 90 即为 90%。	0
AvgObjectSize	string	响应平均大小。单位：byte。	2888253.7875
Bps	string	带宽。	380.9614285714286
Qps	string	每秒查询率。	0.001746031746031746
RegionEname	string	地区英文名称。	chongqing
Region	string	地区信息。	重庆市
Proportion	string	访问占比数据。例如：返回 90 即为 90% 。	0.01155980271270037
BytesProportion	string	总流量占比，例如返回 90 即为 90%。	0.003544181046236794

示例

正常返回示例

JSON格式

{
  "EndTime": "2021-10-31T15:59:59Z",
  "StartTime": "2021-10-30T16:00:00Z",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "DomainName": "example.aliyundoc.com",
  "DataInterval": "3600",
  "Value": {
    "RegionProportionData": [
      {
        "TotalQuery": "3",
        "TotalBytes": "2400057",
        "AvgResponseRate": "154.3345765545624",
        "AvgResponseTime": "5183.666666666667",
        "ReqErrRate": "0",
        "AvgObjectSize": "2888253.7875",
        "Bps": "380.9614285714286",
        "Qps": "0.001746031746031746",
        "RegionEname": "chongqing",
        "Region": "重庆市",
        "Proportion": "0.01155980271270037",
        "BytesProportion": "0.003544181046236794"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidStartTime.Malformed	The format of the specified StartTime is invalid.	开始时间格式不对
400	InvalidEndTime.Malformed	The format of the specified EndTime is invalid.	截止时间格式不对
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	结束时间早于开始时间，请检查
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	不支持该开始时间

访问错误中心查看更多错误码。