CreateDiagnostic - Create a diagnosis task for ROS stacks - 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:CreateDiagnostic

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DiagnosticKey	string	Yes	The diagnostic keyword. Specify the ID of the stack to diagnose.	37A5679B-8488-5A5D-8D5C-90E66A577A5D
Product	string	No	The name of the product to diagnose.	ros
DiagnosticType	string	No	The type of item to diagnose. Set the value to Stack.	Stack
Lang	string	No	The language of the diagnostic report. Only Chinese and English are supported. Valid values: zh-cn en	zh-cn

Response elements

Element	Type	Description	Example
	object
Code	string	The error code.	Forbidden
DiagnosticType	string	The type of the item that is diagnosed.	Stack
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message.	You are not authorized to complete this action.
ReportId	string	The ID of the diagnostic report.	dr-e94e39a1274d44b6****
RequestId	string	The request ID.	943B24D7-1A67-55A4-B045-818F90693D3A
Success	string	Indicates whether the request is successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": "Forbidden",
  "DiagnosticType": "Stack",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to complete this action.",
  "ReportId": "dr-e94e39a1274d44b6****",
  "RequestId": "943B24D7-1A67-55A4-B045-818F90693D3A",
  "Success": "true"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.