GetPADiagnosisTask-阿里云帮助中心

Retrieves the details of a private access diagnostic task.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
DiagnoseId	string	Yes	The ID of the diagnostic task.	diag-58d0750e8786919a

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	2CABFEBB-0CE7-575E-833A-266F75D46713
DiagnosisTask	object	The diagnostic task.
DiagnoseType	string	The diagnostic type. Valid values: FullLink: full-link diagnostics Application: application diagnostics	FullLink
UserGroup	object	The user group.
UserGroupId	string	The ID of the user group.	ug-xxxxx
UserGroupName	string	The name of the user group.	IT
DevTag	string	The ID of the device.	76C08B0F-CEFD-8F01-C1D3-0D5B493B5EAF
Username	string	The username.	zhangsan
Protocol	string	The private access application protocol. Valid values: TCP UDP	All
Host	string	The domain name to be diagnosed.	mtools-admin.redotpay.com
Port	string	The port.	80
PopMode	string	The point of presence (POP) selection mode: AutoSelect: automatic selection ManualSelect: manual selection	AutoSelect
PopId	string	The ID of the POP.	pop-2504cd067e094750
UdpExtraConfigs	object	Additional UDP configurations.
RequestContent	string	The content of the UDP request.	hello
ExpectedResponse	string	The expected response from the backend server.	hello
DiagnoseId	string	The ID of the diagnostic task.	diag-3e0d36d6c15a0502
Status	string	The status of the task. Valid values: Running: The task is running. Finished: The task is complete. Failed: The task failed.	Running
Result	object	The diagnostic result.
Success	boolean	Indicates whether the operation was successful.	True
ErrorMessage	string	The error message.	device offline
FlowId	string	The ID of the request stream.	flow-d918b12f9b974f6489fc
PolicyInfo	object	The policy information.
ProcessTime	integer	The processing duration.	1000
UserGroupInfo	object	The user group information.
Email	string	The email address.	1234@xxxx.com
Telephone	string	The mobile phone number.	123456789
Username	string	The username.	zhangsan
Group	array	The list of department names.
	string	The department name.	IT
MatchedUserGroups	string	The matched user group.	IT
DeviceAttributeInfo	object	The device information.
DevTag	string	The ID of the device.	E9EE1CE7-4AA0-521D-B8E1-E13E47F05E94
DeviceType	string	The operating system of the device. Valid values: Windows: Windows macOS: macOS Linux: Linux Android: Android iOS: iOS Windows_Wuying: Cloud Desktop	macos
Ssid	string	The SSID.	abcd
Process	array	The list of security baseline processes.
	string	The security baseline process.	msedge.exe
File	array	The name of the file.
	string	The name of the file.	[{\"Platform\":\"windows\",\"Path\":\"\",\"Name\":\"\"},{\"Platform\":\"macos\",\"Path\":\"\",\"Name\":\"\"}]
Firewall	string	The firewall.	[{\"Platform\":\"windows\",\"Status\":\"disabled\"},{\"Platform\":\"macos\",\"Status\":\"disabled\"},{\"Platform\":\"linux\",\"Status\":\"disabled\"}]
InnerIp	string	The private IP address of the device.	10.5.208.122
InternetIp	string	The public IP address.	47.98.146.136
Mac	string	The MAC address of the device.	`curl Rj0F9uvI.popscan.xaliyun.com`
Hostname	string	The name of the device. The name can be 1 to 128 characters long and can include letters, numbers, and the following special characters: . , ; - _ / @ and spaces. To query for all devices with names containing 4-byte UTF-8 characters, enter only an underscore (_).	DESKTOP-CVTB5KT.CXISHD01.CATHAY_INS.CHN
MatchedSecurityBaseline	string	The matched security baseline.	Test
ZeroTrustPolicyInfo	object	The zero-trust policy information.
AppName	string	The application name.	MyApp2
PolicyName	string	The name of the zero-trust policy.	保密测试
Action	string	The policy action: Allow: allow Block: block Observe: monitor mode	block
BlockInfo	string	The block information.	access denied
RouteStrategyInfo	object	The name of the routing policy.
StrategyId	string	The policy ID.	av-rtd-091c2d6e3f24aae4
StrategyName	string	The policy name.	1
RouteType	string	The policy type.	connector
NetworkLinkInfo	object	The network connectivity information.
Nodes	array<object>	The forwarding nodes.
	array<object>
Id	integer	The node ID.	1237
NodeType	string	The node type.	stunnel
Address	string	The private access application address. The address can be 1 to 128 characters long and can be an IPv4 address, a CIDR block, a domain name, or a wildcard domain name.	172.27.228.132
CloudNetId	string	The ID of the cloud network instance.	vpc-xxxxxx
GeoData	object	The geographic location information.
Country	string	The country.	CN
Prov	string	The province.	Zhejiang
City	string	The city.	Hangzhou
Isp	string	The Internet Service Provider (ISP).	ChinaTelecom_L2
Success	boolean	Indicates whether the operation was successful.	True
Error	string	The error message.	1
Name	string	The node name.	全局加速
NameEn	string	The English name of the node.	Japan Private POP
ResourceId	string	The resource ID.	pop-xxxxxx
Links	array<object>	The connections between nodes.
	array<object>
FromNode	integer	The source node.	1
ToNode	integer	The destination node.	2
Hops	array<object>	The intermediate hops.
	array<object>
Address	string	The address.	**********************
TTL	string	The Time to Live (TTL).	10
Latency	string	The latency.	10
GeoData	object	The geographic location.
Country	string	The country.	CN
Prov	string	The province.	ZHejiang
City	string	The city.	Haikou City
Isp	string	The ISP.	ChinaMobile_L2
Latency	string	The latency.	10
Success	boolean	Indicates whether the operation was successful.	True
Error	string	The error message.	0
Dns	object	The Domain Name System (DNS) information.
FromNode	integer	The source node.	2
ToNode	integer	The destination node.	3
Hops	array<object>	The intermediate hops.
	array<object>	The array of hops.
	array<object>
Address	string	The private access application address. The address can be 1 to 128 characters long and can be an IPv4 address, a CIDR block, a domain name, or a wildcard domain name.	*******************************************
TTL	string	The TTL.	10
Latency	string	The latency.	10
GeoData	object	The geographic location.
Country	string	The country.	CN
Prov	string	The province.	Zhejiang
City	string	The city.	hangzhou
Isp	string	The ISP.	telecom
Latency	string	The latency.	10
Success	boolean	Indicates whether the operation was successful.	True
Error	string	The error message.	0
DnsType	string	The DNS type.	private-zone
DnsServer	string	The DNS server.	100.100.2.136,100.100.2.138
Result	string	The DNS result.	10.0.0.1
FBT	string	The time to first byte.	300
CreateTime	string	The time when the task was created.	2023-08-17 09:49:03

Examples

Success response

JSON format

{
  "RequestId": "2CABFEBB-0CE7-575E-833A-266F75D46713",
  "DiagnosisTask": {
    "DiagnoseType": "FullLink",
    "UserGroup": {
      "UserGroupId": "ug-xxxxx",
      "UserGroupName": "IT"
    },
    "DevTag": "76C08B0F-CEFD-8F01-C1D3-0D5B493B5EAF",
    "Username": "zhangsan",
    "Protocol": "All",
    "Host": "mtools-admin.redotpay.com",
    "Port": "80",
    "PopMode": "AutoSelect",
    "PopId": "pop-2504cd067e094750",
    "UdpExtraConfigs": {
      "RequestContent": "hello",
      "ExpectedResponse": "hello"
    },
    "DiagnoseId": "diag-3e0d36d6c15a0502",
    "Status": "Running",
    "Result": {
      "Success": true,
      "ErrorMessage": "device offline",
      "FlowId": "flow-d918b12f9b974f6489fc",
      "PolicyInfo": {
        "ProcessTime": 1000,
        "UserGroupInfo": {
          "Email": "1234@xxxx.com",
          "Telephone": "123456789",
          "Username": "zhangsan",
          "Group": [
            "IT"
          ],
          "MatchedUserGroups": "IT"
        },
        "DeviceAttributeInfo": {
          "DevTag": "E9EE1CE7-4AA0-521D-B8E1-E13E47F05E94",
          "DeviceType": "macos",
          "Ssid": "abcd",
          "Process": [
            "msedge.exe"
          ],
          "File": [
            "[{\\\"Platform\\\":\\\"windows\\\",\\\"Path\\\":\\\"\\\",\\\"Name\\\":\\\"\\\"},{\\\"Platform\\\":\\\"macos\\\",\\\"Path\\\":\\\"\\\",\\\"Name\\\":\\\"\\\"}]"
          ],
          "Firewall": "[{\\\"Platform\\\":\\\"windows\\\",\\\"Status\\\":\\\"disabled\\\"},{\\\"Platform\\\":\\\"macos\\\",\\\"Status\\\":\\\"disabled\\\"},{\\\"Platform\\\":\\\"linux\\\",\\\"Status\\\":\\\"disabled\\\"}]",
          "InnerIp": "10.5.208.122",
          "InternetIp": "47.98.146.136",
          "Mac": "`curl Rj0F9uvI.popscan.xaliyun.com`",
          "Hostname": "DESKTOP-CVTB5KT.CXISHD01.CATHAY_INS.CHN",
          "MatchedSecurityBaseline": "Test"
        },
        "ZeroTrustPolicyInfo": {
          "AppName": "MyApp2",
          "PolicyName": "保密测试",
          "Action": "block",
          "BlockInfo": "access denied"
        },
        "RouteStrategyInfo": {
          "StrategyId": "av-rtd-091c2d6e3f24aae4",
          "StrategyName": "1",
          "RouteType": "connector"
        }
      },
      "NetworkLinkInfo": {
        "Nodes": [
          {
            "Id": 1237,
            "NodeType": "stunnel",
            "Address": "172.27.228.132",
            "CloudNetId": "vpc-xxxxxx",
            "GeoData": {
              "Country": "CN",
              "Prov": "Zhejiang",
              "City": "Hangzhou",
              "Isp": "ChinaTelecom_L2"
            },
            "Success": true,
            "Error": "1",
            "Name": "全局加速",
            "NameEn": "Japan Private POP",
            "ResourceId": "pop-xxxxxx"
          }
        ],
        "Links": [
          {
            "FromNode": 1,
            "ToNode": 2,
            "Hops": [
              {
                "Address": "**********************",
                "TTL": "10",
                "Latency": "10",
                "GeoData": {
                  "Country": "CN",
                  "Prov": "ZHejiang",
                  "City": "Haikou City",
                  "Isp": "ChinaMobile_L2"
                }
              }
            ],
            "Latency": "10",
            "Success": true,
            "Error": "0"
          }
        ],
        "Dns": {
          "FromNode": 2,
          "ToNode": 3,
          "Hops": [
            [
              {
                "Address": "*******************************************",
                "TTL": "10",
                "Latency": "10",
                "GeoData": {
                  "Country": "CN",
                  "Prov": "Zhejiang",
                  "City": "hangzhou",
                  "Isp": "telecom"
                }
              }
            ]
          ],
          "Latency": "10",
          "Success": true,
          "Error": "0",
          "DnsType": "private-zone",
          "DnsServer": "100.100.2.136,100.100.2.138",
          "Result": "10.0.0.1"
        },
        "FBT": "300"
      }
    },
    "CreateTime": "2023-08-17 09:49:03"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.