CreatePADiagnosisTask-阿里云帮助中心

Creates a diagnostic task for internal network access.

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

csas:CreatePADiagnosisTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DiagnoseType	string	Yes	The diagnosis type. Valid values: FullLink: full-link diagnosis. Application: application diagnosis.	FullLink
Username	string	No	The username.	Zhaosi
DevTag	string	No	The ID of the terminal device.	2987b3e0-8108-2f99-4d18-3b4f1c1c36d7
UserGroupId	string	No	The user group ID.	用户组ID。
Protocol	string	Yes	The protocol used by the internal network access application. Valid values: TCP UDP.	TCP
Host	string	Yes	The address to diagnose.	socialapp-gateway.client9.me
Port	string	Yes	The port.	80
PopMode	string	Yes	The POP point selection mode. Valid values: AutoSelect: automatic selection. ManualSelect: manual selection.	ManualSelect
PopId	string	No	The POP point ID.	pop-3e244b62357dcafc
UdpExtraConfigs	object	No	The extra configurations for UDP diagnosis. If this parameter is not specified, any response received is considered a success.
RequestContent	string	No	The UDP request content.	hello
ExpectedResponse	string	No	The expected response from the backend server.	hello

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	5F79AE39-6622-5292-87EF-DE45631DE4D7
DiagnosisTask	object	The diagnostic task.
DiagnoseType	string	The diagnosis type. Valid values: FullLink: full-link diagnosis. Application: application diagnosis.	FullLink
UserGroup	object	The user group.
UserGroupId	string	The user group ID.	ug-xxxxxxxx
UserGroupName	string	The user group name.	IT
DevTag	string	The ID of the terminal device.	E9EE1CE7-4AA0-521D-B8E1-E13E47F05E94
Username	string	The username.	zhangsan
Protocol	string	The protocol used by the internal network access application. Valid values: TCP UDP.	TCP
Host	string	The address to diagnose.	172.16.6.1
Port	string	The port.	443
PopMode	string	The POP point selection mode. Valid values: AutoSelect: automatic selection. ManualSelect: manual selection.	AutoSelect
PopId	string	The POP point ID. This parameter is required when manual selection is used.	pop-8ded63ce9d3d317e
UdpExtraConfigs	object	The extra information for UDP diagnosis.
RequestContent	string	The UDP request content.	hello
ExpectedResponse	string	The expected backend server response.	hello
DiagnoseId	string	The diagnostic task ID.	diag-3e0d36d6c15a0502
Status	string	The task running status. Valid values: Running: The task is running. Finished: The task is complete. Failed: The task failed.	Disabled

Examples

Success response

JSON format

{
  "RequestId": "5F79AE39-6622-5292-87EF-DE45631DE4D7",
  "DiagnosisTask": {
    "DiagnoseType": "FullLink",
    "UserGroup": {
      "UserGroupId": "ug-xxxxxxxx",
      "UserGroupName": "IT"
    },
    "DevTag": "E9EE1CE7-4AA0-521D-B8E1-E13E47F05E94",
    "Username": "zhangsan",
    "Protocol": "TCP",
    "Host": "172.16.6.1",
    "Port": "443",
    "PopMode": "AutoSelect",
    "PopId": "pop-8ded63ce9d3d317e",
    "UdpExtraConfigs": {
      "RequestContent": "hello",
      "ExpectedResponse": "hello"
    },
    "DiagnoseId": "diag-3e0d36d6c15a0502",
    "Status": "Disabled"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.