All Products
Search
Document Center

CloudMonitor:DescribeSiteMonitorLog

Last Updated:Jul 26, 2024

Queries the logs of one or more instant test tasks.

Operation description

You can create an instant test task only by using the Alibaba Cloud account that you used to enable Network Analysis and Monitoring.

This topic provides an example to show how to query the logs of an instant test task whose ID is afa5c3ce-f944-4363-9edb-ce919a29****.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cms:DescribeSiteMonitorLoglist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdsstringYes

The IDs of the instant test tasks. Separate multiple task IDs with commas (,).

afa5c3ce-f944-4363-9edb-ce919a29****
IspstringNo

The carrier identification code.

465
CitystringNo

The city identification code.

546
MetricNamestringNo

The name of the metric.

Only the ProbeLog metric is supported.

ProbeLog
StartTimestringNo

The start of the time range to query. The following formats are supported:

  • UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970
  • UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format
Note
  • The specified time range includes the end time and excludes the start time. The start time must be earlier than the end time.
    We recommend that you use UNIX timestamps to prevent time zone-related issues.
1638422474389
EndTimestringNo

The end of the time range to query. Valid values:

  • UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970
  • UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format
Note We recommend that you use UNIX timestamps to prevent time zone-related issues.
1638422475687
NextTokenstringNo

The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.``

IWBjqMYSy0is7zSMGu16****
LengthintegerNo

The number of entries to return on each page. Valid values: 1 to 1440.

1000
FilterstringNo

The filter condition.

You can specify a simple expression, for example, TotalTime>100. In this case, the operation returns only the data for instant test tasks whose total response time exceeds 100 milliseconds.

TotalTime>100

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object

None.

NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

IWBjqMYSy0is7zSMGu16****
Datastring

The logs of the instant test tasks.

\[{\\"redirectCount\\":0.0,\\"SSLConnectTime\\":0.0,\\"pingDetail\\":\\"\\",\\"HTTPConnectTime\\":0.0,\\"isp\\":\\"465\\",\\"errorCode\\":611,\\"ispCN\\":\\"Alibaba\\",\\"resolution\\":\\"\\",\\"areaEN\\":\\"HuaBei\\",\\"taskEndTimestamp\\":1638422475687,\\"targetIspEN\\":\\"\\",\\"TotalTime\\":1.0,\\"taskStartTimestamp\\":1638422474389,\\"countryCN\\":\\"China\\",\\"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\\":\\"North China\\",\\"city\\":\\"546\\",\\"expection\\":\\"\\",\\"suorceIp\\":\\"192.168.XX.XX \\",\\"ispEN\\":\\"Alibaba\\",\\"HTTPDNSTime\\":1.0,\\"targetIsp\\":\\"\\",\\"curlStarttransferTime\\":0.0,\\"provinceCN\\":\\"Beijing\\",\\"timestamp\\":1638422474000,\\"redirectTime\\":0.0,\\"targetCity\\":\\"\\", \\"expect\\":\\"\\",\\"HTTPDownloadSize\\":0.0,\\"localDns\\":\\"192.168.XX.XX\\",\\"cityCN\\":\\"Beijing\\",\\"taskId\\":\\"afa5c3ce-f944-4363-9edb-ce919a29\*\*\*\*\\"}]
RequestIdstring

The request ID.

67F646FA-ED8A-58C2-B461-451DB52C8B14
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The HTTP status code.

**

Description The status code 200 indicates that the request was successful.

200
Messagestring

The returned message.

successful

Examples

Sample success responses

JSONformat

{
  "NextToken": "IWBjqMYSy0is7zSMGu16****",
  "Data": "\\[{\\\\\"redirectCount\\\\\":0.0,\\\\\"SSLConnectTime\\\\\":0.0,\\\\\"pingDetail\\\\\":\\\\\"\\\\\",\\\\\"HTTPConnectTime\\\\\":0.0,\\\\\"isp\\\\\":\\\\\"465\\\\\",\\\\\"errorCode\\\\\":611,\\\\\"ispCN\\\\\":\\\\\"Alibaba\\\\\",\\\\\"resolution\\\\\":\\\\\"\\\\\",\\\\\"areaEN\\\\\":\\\\\"HuaBei\\\\\",\\\\\"taskEndTimestamp\\\\\":1638422475687,\\\\\"targetIspEN\\\\\":\\\\\"\\\\\",\\\\\"TotalTime\\\\\":1.0,\\\\\"taskStartTimestamp\\\\\":1638422474389,\\\\\"countryCN\\\\\":\\\\\"China\\\\\",\\\\\"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\\\\\":\\\\\"North China\\\\\",\\\\\"city\\\\\":\\\\\"546\\\\\",\\\\\"expection\\\\\":\\\\\"\\\\\",\\\\\"suorceIp\\\\\":\\\\\"192.168.XX.XX \\\\\",\\\\\"ispEN\\\\\":\\\\\"Alibaba\\\\\",\\\\\"HTTPDNSTime\\\\\":1.0,\\\\\"targetIsp\\\\\":\\\\\"\\\\\",\\\\\"curlStarttransferTime\\\\\":0.0,\\\\\"provinceCN\\\\\":\\\\\"Beijing\\\\\",\\\\\"timestamp\\\\\":1638422474000,\\\\\"redirectTime\\\\\":0.0,\\\\\"targetCity\\\\\":\\\\\"\\\\\", \\\\\"expect\\\\\":\\\\\"\\\\\",\\\\\"HTTPDownloadSize\\\\\":0.0,\\\\\"localDns\\\\\":\\\\\"192.168.XX.XX\\\\\",\\\\\"cityCN\\\\\":\\\\\"Beijing\\\\\",\\\\\"taskId\\\\\":\\\\\"afa5c3ce-f944-4363-9edb-ce919a29\\*\\*\\*\\*\\\\\"}]\n",
  "RequestId": "67F646FA-ED8A-58C2-B461-451DB52C8B14",
  "Success": "true",
  "Code": "200",
  "Message": "successful"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidQueryParameter%s-
401AccessDeniedExceptionYou donot have sufficient access to perform this action.-
402LimitExceededThe quota for this customer had been reached.-
403ForbiddenYou are not authorized to operate the specified resource.No permission, please use RAM to authorize
406ExceedingQuotaExceeding quota limits.-
409%s%s-
429ThrottlingExceptionThe request was denied due to request throttling.-
500InternalErrorThe request processing has failed due to some unknown error.-
500InternalError%s-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-22The Error code has changed. The request parameters of the API has changedView Change Details
2023-04-03The Error code has changedView Change Details