GetDiagnostic - Query diagnostic report details | ROS API - Resource Orchestration Service

Retrieves the details of a diagnostic report by specifying the diagnostic report ID.

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:GetDiagnostic

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ReportId	string	No	The diagnostic report ID.	dr-d540def087714890****

Response elements

Element	Type	Description	Example
	object
Code	string	The error code.	Forbidden
DiagnosticProduct	string	The name of the diagnostic item.	ros
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message.	The specified parameter ReportId is invalid, Can not find diagnostic report dr-5f6135782f104b0f****.
Recommends	object	The diagnostic suggestions.	{'RosActionMessages': {'Reason': 'Fail to delete stack (fc966920-450a-456b-983c-deeaec8e****), as deletion protection is enabled.', 'Recommend': ''}}
ReportId	string	The diagnostic report ID.	dr-cc80afc48c8741e9****
RequestId	string	The request ID.	96A24844-9603-5E79-BDF4-EFD412FC5D4C
Status	string	The diagnostic status. Valid values: Running: The diagnostic is running. Complete: The diagnostic is complete. Failed: The diagnostic failed.	Running
StatusReason	string	The reason for the diagnostic status.	Complete
Success	string	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
DiagnosticKey	string	The diagnostic keyword.	0938F60C-A2CA-5A2E-9983-03EB1E6D7AE2
DiagnosticTime	string	The diagnostic time in UTC. The time follows the YYYY-MM-DDThh:mm:ssZ format.	2023-03-27T03:32:03Z
HttpCode	string	The HTTP status code.	200
DiagnosticResult	object	The diagnostic result.
StackMessages	object	The stack information.
RosActionMessages	object	The Resource Orchestration Service (ROS) call information.
FailedResources	object	The list of resources that failed the diagnostic.

Examples

Success response

JSON format

{
  "Code": "Forbidden",
  "DiagnosticProduct": "ros",
  "HttpStatusCode": 200,
  "Message": "The specified parameter ReportId is invalid, Can not find diagnostic report dr-5f6135782f104b0f****.",
  "Recommends": {
    "test": "test",
    "test2": 1
  },
  "ReportId": "dr-cc80afc48c8741e9****",
  "RequestId": "96A24844-9603-5E79-BDF4-EFD412FC5D4C",
  "Status": "Running",
  "StatusReason": "Complete",
  "Success": "true",
  "DiagnosticKey": "0938F60C-A2CA-5A2E-9983-03EB1E6D7AE2",
  "DiagnosticTime": "2023-03-27T03:32:03Z",
  "HttpCode": "200",
  "DiagnosticResult": {
    "StackMessages": {
      "test": "test",
      "test2": 1
    },
    "RosActionMessages": {
      "test": "test",
      "test2": 1
    },
    "FailedResources": {
      "test": "test",
      "test2": 1
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.