All Products
Search
Document Center

:Troubleshooting

Last Updated:Apr 17, 2024

This topic describes how to troubleshoot errors when calling API operations.

Diagnostics

OpenAPI Explorer provides a diagnostics feature for errors that occur when API operations are called. If an error occurs when you call API operations, you can use the error code to query the cause and suggestions for the error.

Examples:

  1. Assume that you entered the wrong region ID when calling the DescribeSecurityGroupAttribute operation, and the following error is reported:

    {
      "RequestId": "01C8238B-B79B-50C5-9011-D9AC41509C23",
      "HostId": "ecs-unit-share.cn-hangzhou.aliyuncs.com",
      "Code": "InvalidSecurityGroupId.NotFound",
      "Message": "The specified SecurityGroupId does not exist.",
      "Recommend": "https://api.aliyun.com/troubleshoot?q=InvalidSecurityGroupId.NotFound&product=Ecs"
    }
  2. Go to the Alibaba Cloud OpenAPI Diagnostics page: https://next.api.alibabacloud.com/troubleshoot.

  3. Enter the request ID and click Diagnose.

  4. View the diagnostics result. Example:

    image.png

Check the error code documentation of cloud products

You can search for an error code by using the search feature provided on OpenAPI Explorer or see the API references of the cloud product.