Retrieves error diagnosis solutions based on the provided error code
Operation description
You can call this API operation to query public information rather than sensitive information such as account ownership. Permissions for this API operation cannot be granted to other members.
Try it now
RAM authorization
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. |
1234-56789012 |
errorMessage |
string |
No |
The error message for which you want to query a solution. This parameter must be used together with the errorCode parameter. |
An error occurred while processing your request. |
product |
string |
No |
The product code.
|
oss |
acceptLanguage |
string |
No |
The language of the solution. Valid values: zh-CN and en-US. Not all of the solutions are available in English. This parameter is left empty if a solution has no English content. en-US |
zh-CN |
Response parameters
Parameter |
Type |
Description |
Example |
object |
Schema of Response |
||
solutions |
array |
The list of solutions. Not every error has a diagnosis solution. If you need a solution, you can submit a ticket or provide feedback through the API portal. Each element contains the following properties: |
|
object |
The solution. Each element contains the following properties: |
||
content |
string |
The error code diagnosis solution, returned in markdown format. |
|
solutionId |
string |
The solution ID |
0017-00000502 |
product |
string |
The product code to which the solution belongs. |
Ecs |
productName |
string |
The name of the product to which the solution belongs. |
|
errorCode |
string |
The error code. |
0017-00000502 |
errorMessage |
string |
The error message. |
The resource is not in a valid state for the operation. |
requestId |
string |
The Request ID of this request. |
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. |
For more error codes, see Error Center.