Docs

Network Advisor

Instance Diagnostics

DescribeHistoryDiagnosis - Viewing the instance history diagnosis

Call the DescribeHistoryDiagnosis API to view all historical diagnosis records for a resource instance.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. More information can be found in Common parameters.

Action string required Example: DescribeHistoryDiagnosis

Action to execute. Set the value to DescribeHistoryDiagnosis.

Version string required Example: 2020-04-01

The API version. Value: 2020-04-01.

ResourceInstanceId string required Example: eip-12b8n3mdsl4hs17q7****

Resource instance ID.

Response parameters

Only the response parameters specific to this API are listed below. More information, see Response structure.

HistoryDiagnosis object[] Example: --

Instance diagnosis history.

Created on string Example: 2025-12-31T11:41:30+08:00

Creation time.

DiagnosisInstanceId string Example: di-12b8n3mdsl4hs17q7y2bp****

Instance diagnosis ID.

DiagnosisInstanceStatus string Example: Normal

Instance diagnosis status.

Running

Pass

Hint

Normal

Serious

Fatal

Request example

GET /?Action=DescribeHistoryDiagnosis&Version=2020-04-01&ResourceInstanceId=eip-12b8n3mdsl4hs17q7****​
Host: na.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/na/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "DescribeHistoryDiagnosis",​
        "Version": "2020-04-01",​
        "Service": "na",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "HistoryDiagnosis": [​
            {​
                "CreationTime": "2025-12-31T11:41:30+08:00",​
                "DiagnosisInstanceId": "di-12b8n3mdsl4hs17q7y2bp****",​
                "DiagnosisInstanceStatus": "Hint"​
            }​
        ]​
    }​
}​

Error codes

The following table lists the error codes related to the business logic for this API. For details, see Common error codes.

Status code	Error codes	Error message	Notes
400	DataUnmarshalFailed	Data unmarshal failed.	Failed to parse the request.
400	ErrDataUnmarshalFailed	Data unmarshal failed.	Failed to parse the request.
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request, for example, the ''.	This request does not contain required parameters. Ensure the request includes all required parameters, such as .
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	The format specified for pagination parameter is invalid.
400	InvalidDiagResourceType.NotSupported	The specified resource type is not supported.	The specified resource type is not supported.
401	ServiceRoleUnauthorized	service role is unauthorized	Role not authorized. Please visit the IAM console to grant the required permissions first
500	InternalError	An internal error has occurred.	An internal error occurred.

Last updated: 2026.08.04 19:32:43