GetErrorCodeSolutions-阿里云帮助中心

Operation description

This API queries public information and does not involve account-specific attribution. Therefore, authorization is not supported.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /getErrorCodeSolutions HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
errorCode	string	Yes	The error code for which you want to query the diagnostic solution.	IncorrectStatus.TransitRouter
errorMessage	string	No	The error message for which you want to query the diagnostic solution. This parameter must be used together with the errorCode parameter.	The resource is not in a valid state for the operation.
product	string	No	The product CODE. Call the GetRequestLog operation and obtain the product CODE from the returned result. Find the corresponding product CODE through the OpenAPI portal URL. For example, the OpenAPI portal URL for Short Message Service is https://api.aliyun.com/product/Dysmsapi. Based on this URL, the product CODE for Short Message Service is Dysmsapi.	Ecs
acceptLanguage	string	No	Queries diagnostic solutions in the corresponding language. Chinese (zh-CN) and English (en-US) are supported. Note that not all diagnostic solutions have English content. If a diagnostic solution has no English content, an empty value is returned. zh-CN Valid values: en-US : en-US zh-CN : zh-CN	zh-CN

Response elements

Element	Type	Description	Example
	object	Schema of Response
solutions	array<object>	The list of solutions. Not every error has a corresponding diagnostic solution, and solutions may change due to adjustments in business logic. If needed, you can submit a ticket or visit the API portal to provide feedback.
	object	The list of diagnostic solutions. Each element contains the following attributes:
content	string	The diagnostic solution for the error code, returned in markdown format.	Unsupported transit router status\n====\n\nCause\n----\n\nThe transit router is in an unstable state.\n\n* * *\n\nSolution\n----\n\nTry again after the transit router enters a stable state. You can check whether the transit router is in a stable state based on the following information.\n\nExample\n------\n\nBefore you proceed, make sure that the transit route is in a stable state.\n\n1. Go to the console. If the status of the transit router in the Transit Router list is Available, the transit router is in a stable state.\n\n2. Call the ListTransitRouters operation. If Active is returned for Status, the transit router is in a stable state.
solutionId	string	The solution ID.	0017-00000502
product	string	The product CODE to which the diagnostic solution belongs.	Ecs
productName	string	The product service name to which the diagnostic solution belongs.	Elastic Compute Service
errorCode	string	The error code corresponding to the diagnostic solution.	IncorrectStatus.TransitRouter
errorMessage	string	The error message corresponding to the diagnostic solution.	The resource is not in a valid state for the operation.
requestId	string	The Request ID of this request.	A707AFA8-1A4C-5B2A-A165-8436C1EA38DB

Examples

Success response

JSON format

{
  "solutions": [
    {
      "content": "Unsupported transit router status\\n====\\n\\nCause\\n----\\n\\nThe transit router is in an unstable state.\\n\\n* * *\\n\\nSolution\\n----\\n\\nTry again after the transit router enters a stable state. You can check whether the transit router is in a stable state based on the following information.\\n\\nExample\\n------\\n\\nBefore you proceed, make sure that the transit route is in a stable state.\\n\\n1. Go to the console. If the status of the transit router in the Transit Router list is Available, the transit router is in a stable state.\\n\\n2. Call the ListTransitRouters operation. If Active is returned for Status, the transit router is in a stable state.",
      "solutionId": "0017-00000502",
      "product": "Ecs",
      "productName": "Elastic Compute Service",
      "errorCode": "IncorrectStatus.TransitRouter",
      "errorMessage": "The resource is not in a valid state for the operation."
    }
  ],
  "requestId": "A707AFA8-1A4C-5B2A-A165-8436C1EA38DB"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam.AcceptLanguage	Accepted language should only be zh-CN or en-US.	Invalid parameter. The accepted language can only be zh-CN or en-US.
400	InvalidParam.ErrorCode	The errorCode should be a string and cannot be empty.	Invalid ErrorCode parameter. It must be a string and cannot be empty.
400	InvalidParam.ErrorMessage	The errorMessage should be a string or null.	Invalid errorMessage parameter. ErrorMessage must be a string or null.
400	InvalidParam.Product	The product should be a string or null.	Invalid product parameter. It must be a string or null.
404	NotFound.Product	The provided product does not exist.	The product name you provided does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.