All Products
Search
Document Center

Resource Orchestration Service:CreateDiagnostic

Last Updated:Sep 12, 2024

Creates a dignosis task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ros:CreateDiagnosticcreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DiagnosticKeystringNo

The keyword in the diagnosis.

You can specify the ID of the stack that you want to diagnose.

37A5679B-8488-5A5D-8D5C-90E66A577A5D
ProductstringNo

The name of the product that is diagonosed.

ros
DiagnosticTypestringNo

The type of the item that is diagnosed. Set the value to Stack, which specifies that the stack is diagnosed.

Stack
LangstringNo

The language of the diagnostic report to be generated. Only Chinese and English are supported.

Valid values:

  • zh-cn
  • en
zh-cn

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The error code returned.

Forbidden
DiagnosticTypestring

The type of the item that is diagnosed.

Stack
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The error message returned.

You are not authorized to complete this action.
ReportIdstring

The ID of the diagnostic report.

dr-e94e39a1274d44b6****
RequestIdstring

The request ID.

943B24D7-1A67-55A4-B045-818F90693D3A
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
2024-03-22The request parameters of the API has changedView Change Details