ListDiagnostics - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries a diagnostic report.

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
ros:ListDiagnostics	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
DiagnosticKey	string	No	The keyword in the diagnosis.	2829A772-B154-5A0A-B61B-DEE8A9EE8A5D
DiagnosticProduct	string	No	The product that is diagnosed.	ros
Status	string	No	The diagnosis status.	Complete
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f01****
MaxResults	string	No	The maximum number of results to be returned in a single call when NextToken is used for the query. Valid values: 1 to 100. Default value: 50.	50

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code returned. The value 200 indicates that the request was successful.	200
Message	string	The error message returned.	You are not authorized to complete this action.
Diagnostics	array<object>	The items that are diagnosed.
	object
CreateTime	string	The time when the diagnostic report was generated.	2022-08-01T02:23:55
DiagnosticKey	string	The keyword in the diagnosis.	047D84D9-D3EB-5DA8-87F1-9A7DD5598A5D
DiagnosticProduct	string	The product that is diagnosed.	ros
ReportId	string	The ID of the diagnostic report.	dr-2963bfbcac834f1a****
Status	string	The diagnosis status.	success
RequestId	string	The request ID.	1983D1C4-88EA-5D7D-90AB-467D01867A5D
Success	string	Indicates whether the request was successful. Valid values: true false	true
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f01****

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Message": "You are not authorized to complete this action.",
  "Diagnostics": [
    {
      "CreateTime": "2022-08-01T02:23:55",
      "DiagnosticKey": "047D84D9-D3EB-5DA8-87F1-9A7DD5598A5D",
      "DiagnosticProduct": "ros",
      "ReportId": "dr-2963bfbcac834f1a****",
      "Status": "success"
    }
  ],
  "RequestId": "1983D1C4-88EA-5D7D-90AB-467D01867A5D",
  "Success": "true",
  "NextToken": "caeba0bbb2be03f84eb48b699f01****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history