调用DescribeSiteMonitorData接口查询任务的细粒度监控数据。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSiteMonitorData

要执行的操作,取值:DescribeSiteMonitorData。

MetricName String Availability

监控项的名称。取值:

  • Availability:可用率
  • ResponseTime:响应时间
TaskId String 49f7b317-7645-4cc9-94fd-ea42e522****

任务ID。

Type String metric

监控的数据类型。取值:

  • metric:时序类指标监控
  • event:事件类监控
StartTime String 1551579637000

开始时间。支持的格式:

  • Unix时间戳:从1970年1月1日开始所经过的毫秒数。
  • Format格式:YYYY-MM-DDThh:mm:ssZ。
EndTime String 1551581437000

结束时间。支持的格式:

  • Unix时间戳:从1970年1月1日开始所经过的毫秒数。
  • Format格式:YYYY-MM-DDThh:mm:ssZ。
Period String 60

统计周期。单位:秒,取值为60或60的整数倍。

说明 默认根据探测频率最小周期返回数据。
NextToken String 49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****

分页游标。

Length Integer 1000

返回的数据点数量。

返回数据

名称 类型 示例值 描述
RequestId String 3febb181-0d98-4af9-8b04-7faf36b048b9

请求ID。

Code String 200

状态码。

说明 200表示成功。
Success String true

操作是否成功。true表示成功,false表示失败。

NextToken String ea42e5220930ea42e522****

分页游标。

Data String [{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]

监控数据。

Message String Successful

返回信息。

返回结果是一个JSON字符串,描述信息如下:

  • Error4XXRate:4XX错误占比
  • Error6XXRate:6xx错误占比
  • Error5XXRate:5xx错误占比
  • Error4XXNumber:4xx错误探针的数量
  • Error5XXNumber:5xx错误探针的数量
  • Error6XXNumber:6xx错误探针数量
  • Over5totalTime:响应时间超过5000毫秒的占比
  • Over3totalTime:响应时间超过3000毫秒的占比
  • Over2totalTime:响应时间超过2000毫秒的占比
  • Over10FailureRate:错误大于10%所占的比例
  • Over100FailureRate:错误大于99%所占的比例
  • Over30FailureRate:错误大于30%所占的比例
  • Over50FailureRate:错误大于50%所占的比例
  • Over80FailureRate:错误大于80%所占的比例
  • Over90FailureRate:错误大于90%所占的比例
  • Over400NumberRate:超过4XX错误所占的比例
  • Over500NumberRate:超过5XX错误所占的比例
  • AvailableNumber:可用探针数量
  • UnavailableNumber:不可用探测点数量
  • Availability:可用率
  • Unavailability:不可用率
  • ErrorCodeMaximum:最大错误码,例如:1分钟内5个探测点有4个是200, 1个是404, 那么最大错误码就是404
  • ErrorCodeMinimum:最小错误码, 例如:1分钟内5个探测点有4个是200, 1个是404, 那么最小错误码就是200
说明 建议您使用AvailableNumber、UnavailableNumber、Availability、Unavailability、ErrorCodeMaximum或ErrorCodeMinimum,其他计算方式较繁琐。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSiteMonitorData
&MetricName=Availability
&TaskId=49f7b317-7645-4cc9-94fd-ea42e522****
&<公共请求参数>

正常返回示例

XML 格式

<DescribeSiteMonitorData>
		  <Data>
			    <Over5totalTime>0</Over5totalTime>
			    <Error4XXRate>0</Error4XXRate>
			    <UnavailableNumber>0</UnavailableNumber>
			    <Over2totalTime>0</Over2totalTime>
			    <timestamp>1551581040000</timestamp>
			    <Over100FailureRate>0</Over100FailureRate>
			    <Over10FailureRate>0</Over10FailureRate>
			    <Availability>100</Availability>
			    <Over80FailureRate>0</Over80FailureRate>
			    <userId>123****</userId>
			    <AvailableNumber>2</AvailableNumber>
			    <Unavailability>0</Unavailability>
			    <ErrorCodeMaximum>0</ErrorCodeMaximum>
			    <Over10totalTime>0</Over10totalTime>
			    <taskId>49f7b317-7645-4cc9-94fd-1****</taskId>
			    <Over30FailureRate>0</Over30FailureRate>
			    <Error6XXRate>0</Error6XXRate>
			    <Over500NumberRate>0</Over500NumberRate>
			    <Over3totalTime>0</Over3totalTime>
			    <Over400NumberRate>0</Over400NumberRate>
			    <Error5XXRate>0</Error5XXRate>
			    <Error5XXNumber>0</Error5XXNumber>
			    <Over90FailureRate>0</Over90FailureRate>
			    <Error4XXNumber>0</Error4XXNumber>
			    <Over50FailureRate>0</Over50FailureRate>
			    <ErrorCodeMinimum>0</ErrorCodeMinimum>
			    <Error6XXNumber>0</Error6XXNumber>
		  </Data>
		  <Data>
			    <Over5totalTime>0</Over5totalTime>
			    <Error4XXRate>0</Error4XXRate>
			    <UnavailableNumber>0</UnavailableNumber>
			    <Over2totalTime>0</Over2totalTime>
			    <timestamp>1551581100000</timestamp>
			    <Over100FailureRate>0</Over100FailureRate>
			    <Over10FailureRate>0</Over10FailureRate>
			    <Availability>100</Availability>
			    <Over80FailureRate>0</Over80FailureRate>
			    <userId>12345</userId>
			    <AvailableNumber>2</AvailableNumber>
			    <Unavailability>0</Unavailability>
			    <ErrorCodeMaximum>0</ErrorCodeMaximum>
			    <Over10totalTime>0</Over10totalTime>
			    <taskId>49f7b317-7645-4cc9-94fd-1****</taskId>
			    <Over30FailureRate>0</Over30FailureRate>
			    <Error6XXRate>0</Error6XXRate>
			    <Over500NumberRate>0</Over500NumberRate>
			    <Over3totalTime>0</Over3totalTime>
			    <Over400NumberRate>0</Over400NumberRate>
			    <Error5XXRate>0</Error5XXRate>
			    <Error5XXNumber>0</Error5XXNumber>
			    <Over90FailureRate>0</Over90FailureRate>
			    <Error4XXNumber>0</Error4XXNumber>
			    <Over50FailureRate>0</Over50FailureRate>
			    <ErrorCodeMinimum>0</ErrorCodeMinimum>
			    <Error6XXNumber>0</Error6XXNumber>
		  </Data>
		  <RequestId>DBDEAC51-EA3C-4853-8F25-6B48D38A28A9</RequestId>
		  <Success>true</Success>
		  <Code>200</Code>
</DescribeSiteMonitorData>

JSON 格式

{
    "Data": [
        {
            "Over5totalTime": 0,
            "Error4XXRate": 0,
            "UnavailableNumber": 0,
            "Over2totalTime": 0,
            "timestamp": 1551581040000,
            "Over100FailureRate": 0,
            "Over10FailureRate": 0,
            "Availability": 100,
            "Over80FailureRate": 0,
            "userId": "123****",
            "AvailableNumber": 2,
            "Unavailability": 0,
            "ErrorCodeMaximum": 0,
            "Over10totalTime": 0,
            "taskId": "49f7b317-7645-4cc9-94fd-1****",
            "Over30FailureRate": 0,
            "Error6XXRate": 0,
            "Over500NumberRate": 0,
            "Over3totalTime": 0,
            "Over400NumberRate": 0,
            "Error5XXRate": 0,
            "Error5XXNumber": 0,
            "Over90FailureRate": 0,
            "Error4XXNumber": 0,
            "Over50FailureRate": 0,
            "ErrorCodeMinimum": 0,
            "Error6XXNumber": 0
        },
        {
            "Over5totalTime": 0,
            "Error4XXRate": 0,
            "UnavailableNumber": 0,
            "Over2totalTime": 0,
            "timestamp": 1551581100000,
            "Over100FailureRate": 0,
            "Over10FailureRate": 0,
            "Availability": 100,
            "Over80FailureRate": 0,
            "userId": "12345",
            "AvailableNumber": 2,
            "Unavailability": 0,
            "ErrorCodeMaximum": 0,
            "Over10totalTime": 0,
            "taskId": "49f7b317-7645-4cc9-94fd-1****",
            "Over30FailureRate": 0,
            "Error6XXRate": 0,
            "Over500NumberRate": 0,
            "Over3totalTime": 0,
            "Over400NumberRate": 0,
            "Error5XXRate": 0,
            "Error5XXNumber": 0,
            "Over90FailureRate": 0,
            "Error4XXNumber": 0,
            "Over50FailureRate": 0,
            "ErrorCodeMinimum": 0,
            "Error6XXNumber": 0
        }
    ],
    "RequestId": "DBDEAC51-EA3C-4853-8F25-6B48D38A28A9",
    "Success": true,
    "Code": "200"
}

错误码

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