All Products
Search
Document Center

Elastic Compute Service:CreateDiagnosticReport

Last Updated:Oct 23, 2026

Creates a resource diagnostic report. Generates a diagnostic report for multiple diagnostic metrics based on the specified diagnostic metric set ID. You can call the DescribeDiagnosticReportAttributes operation to query the details of the resource diagnostic report based on the returned 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

ecs:CreateDiagnosticReport

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID. You can call the DescribeRegions operation to query the latest Alibaba Cloud region list.

cn-hangzhou

ResourceId

string

Yes

The resource ID.

i-uf6i0tv2refv8wz*****

MetricSetId

string

No

The diagnostic metric set ID. If this parameter is left empty, the default diagnostic metric set dms-instancedefault for ECS instances is used.

dms-uf6i0tv2refv8wz*****

StartTime

string

No

The start time. The time follows the ISO 8601 standard and is displayed in UTC. This parameter takes effect only for diagnostic metrics that do not require Cloud Assistant commands to be executed in the guest OS.

2022-07-11T12:00Z

EndTime

string

No

The end time. The time follows the ISO 8601 standard and is displayed in UTC. This parameter takes effect only for diagnostic metrics that do not require Cloud Assistant commands to be executed in the guest OS.

2022-07-11T14:00Z

AdditionalOptions

object

No

The extension in JSON format.

string

No

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE*****

ReportId

string

The diagnostic report ID, which is the unique identifier of the resource diagnostic report.

dr-uf6i0tv2refv8wz*****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "ReportId": "dr-uf6i0tv2refv8wz*****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidResource.NotExists The specified resource not exists.
400 InvalidParameter %s The specified parameter is invalid.
400 InvalidOperation.CloudAssistantNotReady Cloud Assistant is not installed, or the service is unavailable. Install Cloud Assistant or check the status of Cloud Assistant first. Cloud Assistant is not installed, or the service is unavailable. Install Cloud Assistant or check the status of Cloud Assistant first.
403 InvalidAxt.ServiceNotReady %s
403 Forbidden.CreateSLR You are not authorized to do this action. You do not have permission to create a service-linked role.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.