ListProbeTask - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries a probe task.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:ListProbeTask	List	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the SAG instance. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
SagId	string	Yes	The ID of the SAG instance.	sag-****
Sn	string	Yes	The serial number of the SAG device.	sag****
ProbeTaskId	string	Yes	The ID of the probe task.	probe-****
TaskName	string	Yes	The name of the probe task.	test-ping
Protocol	string	Yes	The protocol of the probe task. Valid values: ICMP TCP HTTP Note Tasks that probe private networks support only ICMP and TCP.	ICMP
SagName	string	Yes	The name of the SAG instance.	shanghai-office
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	324223F3-93D3-4CE4-B26F-66C0C3809922
Code	string	The response code.	200
Message	string	The response message.	successful
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	1
Data	object []	The information about the probe task.	probe-xxx
ProbeTaskId	string	The ID of the probe task.	probe-****
TaskName	string	The name of the probe task.	test-ping
SagId	string	The ID of the SAG instance.	sag-asdfz6ac74oj5v****
Sn	string	The serial number of the SAG device.	sag****
Type	string	The type of the probe task. Valid values: Internet: probes a public network. Intranet: probes a private network.	Internet
Protocol	string	The protocol of the probe task. Valid values: ICMP TCP HTTP Note Tasks that probe private networks support only ICMP and TCP.	ICMP
Domain	string	The domain name that is probed by the task.	www.example.com
Port	integer	The port that is probed by the task.	80
PacketNumber	integer	The number of probe packets transmitted by the probe task per minute.	10
ProbeTaskSourceAddress	string	The source address of the probe task.	192.168.1.1
Enable	boolean	Indicates whether the probe task is enabled. Valid values: true: enabled false: disabled	true
GmtCreate	string	The time when the probe task was created.	2022-11-23 14:09
GmtModify	string	The time when the probe task was modified.	2022-11-23 14:09

Examples

Sample success responses

JSONformat

{
  "RequestId": "324223F3-93D3-4CE4-B26F-66C0C3809922",
  "Code": "200",
  "Message": "successful",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "ProbeTaskId": "probe-****",
      "TaskName": "test-ping",
      "SagId": "sag-asdfz6ac74oj5v****",
      "Sn": "sag****",
      "Type": "Internet",
      "Protocol": "ICMP",
      "Domain": "www.example.com",
      "Port": 80,
      "PacketNumber": 10,
      "ProbeTaskSourceAddress": "192.168.1.1",
      "Enable": true,
      "GmtCreate": "2022-11-23 14:09",
      "GmtModify": "2022-11-23 14:09"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidName	The specified name is not valid.	The specified name is invalid.
400	InvalidProbeProtocol	The specified probe task protocol is invalid.	The protocol of the probing task is invalid.

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