DescribeUrlObservationData - 查询网页观测质量数据_边缘安全加速(ESA)-阿里云帮助中心

查询网页观测质量数据。

接口说明

如果您不指定 StartTime 和 EndTime，该接口返回过去 24 小时的数据；指定 StartTime 和 EndTime，该接口返回指定时间段的数据。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
esa:DescribeUrlObservationData	none	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	无	无

请求参数

名称	类型	必填	描述	示例值
SiteId	string	是	站点 ID，可通过调用 ListSites 接口获取。	54362329990032
StartTime	string	否	获取数据的开始时间。日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2023-04-08T16:00:00Z
EndTime	string	否	获取数据的结束时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：yyyy-MM-DDThh:mm:ssZ。	2023-04-19T15:59:59Z
Url	string	否	要监测的网页 URL。	example.com/test
ClientPlatform	string	否	设备平台，参数为空则查询全部。 PC Mobile	PC
Metric	string	否	检测的指标数据。 TTFB：度量资源发起请求到响应的第一个字节开始到达之间的时间。 FCP：度量从页面开始加载到页面内容的任何部分在屏幕上呈现这之间的时间。 LCP：报告视区中可见的最大图像或文本块的呈现时间。 CLS：一个度量页面整个生命周期内发生的每一次意外布局变化的最大布局突变分数的度量值。 INP：度量页面的响应能力，页面需要多长时间以看得见的方式响应用户输入。 FID：度量从用户第一次与页面交互到浏览器实际能够为响应该交互开始处理事件处理程序这之间的时间。	TTFB

返回参数

名称	类型	描述	示例值
	object	Schema of Response
UrlDetailData	array<object>	返回数据。
content	object
Url	string	要监测的网页 URL。	example.com/test
ClientPlatform	string	设备平台。	PC
Country	string	所属国家。	CN
TTFB	float	度量资源发起请求到响应的第一个字节开始到达之间的时间，单位：ms。	123
FCP	float	度量从页面开始加载到页面内容的任何部分在屏幕上呈现这之间的时间，单位：ms。	123
LCP	float	报告视区中可见的最大图像或文本块的呈现时间，单位：ms。	123
CLS	float	一个度量页面整个生命周期内发生的每一次意外布局变化的最大布局突变分数的度量值。	0.5
FID	float	度量从用户第一次与页面交互到浏览器实际能够为响应该交互开始处理事件处理程序这之间的时间，单位：ms。	123
INP	float	度量页面的响应能力，页面需要多长时间以看得见的方式响应用户输入，单位：ms。	123
RequestId	string	请求 ID。	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
StartTime	string	开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ。	2022-11-06T16:00:00Z
EndTime	string	获取数据的结束时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：yyyy-MM-DDThh:mm:ssZ。	2023-04-19T15:59:59Z

示例

正常返回示例

JSON格式

{
  "UrlDetailData": [
    {
      "Url": "example.com/test",
      "ClientPlatform": "PC",
      "Country": "CN",
      "TTFB": 123,
      "FCP": 123,
      "LCP": 123,
      "CLS": 0.5,
      "FID": 123,
      "INP": 123
    }
  ],
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "StartTime": "2022-11-06T16:00:00Z",
  "EndTime": "2023-04-19T15:59:59Z"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.TimeRange	The specified time range exceeds the limit. Adjust it and try again.	您配置的数据查询时间范围过长，请调整数据查询时间范围后重试。
400	TooManyRequests	Too many requests.Please try again later.	请求过于频繁，请稍后重试。
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	您填入的结束时间早于开始时间，请检查后重试。
400	InvalidParameter	Parameter verification failed. Check your configurations and try again.	输入的参数校验不通过，请您核对参数的正确性后重试。
400	InvalidTime.Malformed	Specified start time or end time is malformed.	您指定的时间格式有误，时间需要符合yyyy-MM-ddTHH:mm:ssZ格式。请您正确输入后重试。

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