DescribeSiteMonitorLog - Cloud Monitor - Alibaba Cloud Documentation Center

Call the DescribeSiteMonitorLog operation to query the detection logs for a one-time detection task.

Operation description

Only Alibaba Cloud accounts with Network Analysis and Monitoring activated can create one-time detection tasks.

This topic provides an example of how to query the detection logs for the one-time detection task afa5c3ce-f944-4363-9edb-ce919a29****.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeSiteMonitorLog

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskIds	string	Yes	The ID of the detection task. You can specify multiple task IDs. Separate them with commas (,).	afa5c3ce-f944-4363-9edb-ce919a29****
Isp	string	No	The carrier ID.	465
City	string	No	The city ID.	546
MetricName	string	No	The metric. Only the `ProbeLog` metric is supported.	ProbeLog
StartTime	string	No	The beginning of the time range to query. The following formats are supported: UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970. UTC format: YYYY-MM-DDThh:mm:ssZ. Note The start time and end time follow the (StartTime, EndTime] pattern. The value of StartTime cannot be the same as or later than the value of EndTime. - Use UNIX timestamps to prevent time zone-related issues.	1638422474389
EndTime	string	No	The end of the time range to query. The following formats are supported: UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970. UTC format: YYYY-MM-DDThh:mm:ssZ. Note Use UNIX timestamps to prevent time zone-related issues.	1638422475687
NextToken	string	No	If the response is truncated, use the `NextToken` parameter to retrieve the next page of results.	IWBjqMYSy0is7zSMGu16****
Length	integer	No	The number of entries to return on each page for a paged query. Valid values: 1 to 1440.	1000
Filter	string	No	The filter expression for detection results. Simple expressions are supported. For example, you can use the `TotalTime>100` expression to query the detection data whose total response time exceeds 100 milliseconds.	TotalTime>100
BrowserInfo	string	No	This parameter is deprecated. You do not need to specify this parameter.	无
Browser	string	No	The type of the browser. Valid values: Chrome : Chrome Safari : Safari Edge : Edge Firefox : Firefox	Chrome
Device	string	No	The type of the device. This parameter specifies the screen size for impersonation. Valid values: tablet : tablet mobile : mobile laptop : laptop	laptop

Response elements

Element	Type	Description	Example
	object	N/A
NextToken	string	The token that is used to query the next page.	IWBjqMYSy0is7zSMGu16****
Data	string	The detection logs of the one-time detection task.	[{\"redirectCount\":0.0,\"SSLConnectTime\":0.0,\"pingDetail\":\"\",\"HTTPConnectTime\":0.0,\"isp\":\"465\",\"errorCode\":611,\"ispCN\":\"阿里巴巴\",\"resolution\":\"\",\"areaEN\":\"HuaBei\",\"taskEndTimestamp\":1638422475687,\"targetIspEN\":\"\",\"TotalTime\":1.0,\"taskStartTimestamp\":1638422474389,\"countryCN\":\"中国\",\"provinceEN\":\"Beijing\",\"countryEN\":\"China\",\"targetCityEN\":\"\",\"curlConnectTime\":0.0,\"ips\":\"\",\"route\":\"\",\"tcpConnectTime\":0.0,\"cityEN\":\"Beijing\",\"HTTPDownloadSpeed\":0.0,\"HTTPDownloadTime\":0.0,\"HTTPResponseCode\":0.0,\"areaCN\":\"华北\",\"city\":\"546\",\"expection\":\"\",\"suorceIp\":\"192.168.XX.XX \",\"ispEN\":\"Alibaba\",\"HTTPDNSTime\":1.0,\"targetIsp\":\"\",\"curlStarttransferTime\":0.0,\"provinceCN\":\"北京市\",\"timestamp\":1638422474000,\"redirectTime\":0.0,\"targetCity\":\"\", \"expect\":\"\",\"HTTPDownloadSize\":0.0,\"localDns\":\"192.168.XX.XX\",\"cityCN\":\"北京市\",\"taskId\":\"afa5c3ce-f944-4363-9edb-ce919a29****\"}]
RequestId	string	The request ID.	67F646FA-ED8A-58C2-B461-451DB52C8B14
Success	string	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
Code	string	The status code. Note A status code of 200 indicates that the operation was successful.	200
Message	string	The returned message.	successful

Examples

Success response

JSON format

{
  "NextToken": "IWBjqMYSy0is7zSMGu16****",
  "Data": "[{\\\"redirectCount\\\":0.0,\\\"SSLConnectTime\\\":0.0,\\\"pingDetail\\\":\\\"\\\",\\\"HTTPConnectTime\\\":0.0,\\\"isp\\\":\\\"465\\\",\\\"errorCode\\\":611,\\\"ispCN\\\":\\\"阿里巴巴\\\",\\\"resolution\\\":\\\"\\\",\\\"areaEN\\\":\\\"HuaBei\\\",\\\"taskEndTimestamp\\\":1638422475687,\\\"targetIspEN\\\":\\\"\\\",\\\"TotalTime\\\":1.0,\\\"taskStartTimestamp\\\":1638422474389,\\\"countryCN\\\":\\\"中国\\\",\\\"provinceEN\\\":\\\"Beijing\\\",\\\"countryEN\\\":\\\"China\\\",\\\"targetCityEN\\\":\\\"\\\",\\\"curlConnectTime\\\":0.0,\\\"ips\\\":\\\"\\\",\\\"route\\\":\\\"\\\",\\\"tcpConnectTime\\\":0.0,\\\"cityEN\\\":\\\"Beijing\\\",\\\"HTTPDownloadSpeed\\\":0.0,\\\"HTTPDownloadTime\\\":0.0,\\\"HTTPResponseCode\\\":0.0,\\\"areaCN\\\":\\\"华北\\\",\\\"city\\\":\\\"546\\\",\\\"expection\\\":\\\"\\\",\\\"suorceIp\\\":\\\"192.168.XX.XX \\\",\\\"ispEN\\\":\\\"Alibaba\\\",\\\"HTTPDNSTime\\\":1.0,\\\"targetIsp\\\":\\\"\\\",\\\"curlStarttransferTime\\\":0.0,\\\"provinceCN\\\":\\\"北京市\\\",\\\"timestamp\\\":1638422474000,\\\"redirectTime\\\":0.0,\\\"targetCity\\\":\\\"\\\", \\\"expect\\\":\\\"\\\",\\\"HTTPDownloadSize\\\":0.0,\\\"localDns\\\":\\\"192.168.XX.XX\\\",\\\"cityCN\\\":\\\"北京市\\\",\\\"taskId\\\":\\\"afa5c3ce-f944-4363-9edb-ce919a29****\\\"}]",
  "RequestId": "67F646FA-ED8A-58C2-B461-451DB52C8B14",
  "Success": "true",
  "Code": "200",
  "Message": "successful"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.	No permission, please use RAM to authorize
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	The number of tasks exceeds the limit
429	ThrottlingException	The request was denied due to request throttling.
409	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.