ListDiagnostics - List diagnostic reports - Resource Orchestration Service

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

ros:ListDiagnostics

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DiagnosticKey	string	No	The diagnostic keyword.	2829A772-B154-5A0A-B61B-DEE8A9EE8A5D
DiagnosticProduct	string	No	The diagnosed product.	ros
Status	string	No	The diagnostic status.	Complete
NextToken	string	No	A pagination token. Use this token in the next request to retrieve additional results.	caeba0bbb2be03f84eb48b699f01****
MaxResults	string	No	The maximum number of entries per page when using NextToken-based pagination. Valid values: 1 to 100. Default value: 50.	50

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code. A value of 200 indicates success.	200
Message	string	The error message.	You are not authorized to complete this action.
Diagnostics	array<object>	The diagnostic items.
	object
CreateTime	string	The time when the report was created.	2022-08-01T02:23:55
DiagnosticKey	string	The diagnostic keyword.	047D84D9-D3EB-5DA8-87F1-9A7DD5598A5D
DiagnosticProduct	string	The diagnosed product.	ros
ReportId	string	The diagnostic report ID.	dr-2963bfbcac834f1a****
Status	string	The diagnostic 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	A pagination token. Use this token in the next request to retrieve additional results.	caeba0bbb2be03f84eb48b699f01****

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.