All Products
Search
Document Center

Smart Access Gateway:ListProbeTask

Last Updated:Nov 19, 2026

Queries probe tasks.

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

smartag:ListProbeTask

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID of the SAG instance.

Call the DescribeRegions operation to query the most recent region list.

cn-shanghai

SagId

string

No

The ID of the SAG instance.

sag-****

Sn

string

No

The serial number of the SAG device.

sag****

ProbeTaskId

string

No

The ID of the probe task.

probe-****

TaskName

string

No

The name of the probe task.

test-ping

Protocol

string

No

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

No

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 elements

Element

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

array<object>

The information about the probe task.

probe-xxx

object

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 sent 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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.