ListDiagnosticResults-阿里云帮助中心

Queries a list of diagnostic results.

Operation description

Creates a session, returns the frontend endpoint, and starts a periodic task to track the session status.

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

eflo:ListDiagnosticResults

get

*Cluster

acs:eflo:{#regionId}:{#accountId}:cluster/*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token for the next page. Include this token when you request the next page.	a3f2224a5ec7224116c4f5246120****
MaxResults	integer	No	The maximum number of entries per page. Maximum value: 100. Default value: If no value is set or the set value is less than 20, the default value is 20. If the set value is greater than 100, the default value is 100.	20
DiagType	string	No	The diagnostic type, which indicates the diagnostic rules that are matched.	NetDiag
ResourceGroupId	string	No	The resource group ID.	rg-acfmywpvugk****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	AC4F0004-7BCE-52E0-891B-CAC7D64E3368
DiagnosticResults	array<object>	The diagnostic information.
	object	The diagnostic information.
DiagContent	string	The diagnostic content. For example, network diagnostics includes static configuration checks, dynamic operation checks, and other types of diagnostic content.	Test diagnostic information
ResourceId	string	The resource ID.	e01-cn-bl03ofg6****
ClusterId	string	The cluster ID.	i11857814169474524****
DiagId	string	The diagnostic task ID.	123
Status	string	The status of the diagnostic task. Valid values: InProgress: The diagnostic task is in progress. Finished: The diagnostic task is complete. Failed: The diagnostic task failed.	succeed
CreationTime	string	The time when the diagnostic task was created.	2024-01-15T02:01:12Z
FinishedTime	string	The time when the diagnostic task was completed.	2024-10-16T02:04Z
DiagResult	string	The diagnostic result. Valid values: Success and Failure.	Success
ServerName	string	The server name.	proxy-rps.mos.csvw.com
ClusterName	string	The cluster name.	pjlab-lingjun
NextToken	string	The token for the next page. Include this token when you request the next page.	a3f2224a5ec7224116c4f5246120****
MaxResults	integer	The maximum number of entries per page. Maximum value: 100. Default value: If no value is set or the set value is less than 20, the default value is 20. If the set value is greater than 100, the default value is 100.	20

Examples

Success response

JSON format

{
  "RequestId": "AC4F0004-7BCE-52E0-891B-CAC7D64E3368",
  "DiagnosticResults": [
    {
      "DiagContent": "Test diagnostic information",
      "ResourceId": "e01-cn-bl03ofg6****",
      "ClusterId": "i11857814169474524****",
      "DiagId": "123",
      "Status": "succeed",
      "CreationTime": "2024-01-15T02:01:12Z",
      "FinishedTime": "2024-10-16T02:04Z",
      "DiagResult": "Success",
      "ServerName": "proxy-rps.mos.csvw.com",
      "ClusterName": "pjlab-lingjun"
    }
  ],
  "NextToken": "a3f2224a5ec7224116c4f5246120****",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.