GetErrorCodeSolutions - OpenAPI Explorer - Alibaba Cloud Documentation Center

Operation description

You can call this API operation to query public information instead of special information, such as the account ownership. Permissions on this API operation cannot be granted to other members.

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 based on which you want to query a solution.	IncorrectStatus.TransitRouter
errorMessage	string	No	The error message for which you want to query a solution. This parameter must be configured together with the errorCode parameter.	The resource is not in a valid state for the operation.
product	string	No	The product code. You can use one of the following methods to query a product code: Call the GetRequestLog operation to query a product code from the response. Query the code of a product in the OpenAPI Explorer URL of the product. For example, the OpenAPI Explorer URL of Short Message Service (SMS) is https://api.alibabacloud.com/product/Dysmsapi. Therefore, the product code of SMS is Dysmsapi.	Ecs
acceptLanguage	string	No	The language of the solution. Valid values: zh-CN and en-US. Not all of the solutions are available in English. If you set this parameter to en-US, but the corresponding solution is actually not available in English, no response is returned. Valid values: en-US : en-US zh-CN : zh-CN	zh-CN

Response elements

Element	Type	Description	Example
	object	The response parameters.
solutions	array<object>	The solutions. Not all error codes have corresponding solutions. You can submit a ticket or use OpenAPI Explorer to contact technical support if necessary.
	object	The solution.
content	string	The content of the solution, which is in the 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 code of the product to which the solution belongs.	Ecs
productName	string	The name of the product to which the solution belongs.	Elastic Compute Service
errorCode	string	The error code.	IncorrectStatus.TransitRouter
errorMessage	string	The error message.	The resource is not in a valid state for the operation.
requestId	string	The request ID.	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 argument, only accepted languages are zh-CN or en-US.
400	InvalidParam.ErrorCode	The errorCode should be a string and cannot be empty.	The ErrorCode parameter is invalid. It should be a string and cannot be empty.
400	InvalidParam.ErrorMessage	The errorMessage should be a string or null.	The parameter errorMessage is invalid. ErrorMessage should be a string or null.
400	InvalidParam.Product	The product should be a string or null.	The argument product is not valid, it should 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.