Cloud Control API:Troubleshooting

Cloud product runtime error codes

These error codes are returned by cloud product APIs at runtime.

The following two error codes are cloud product runtime errors. Parse the `Message` field for detailed error information. The `Message` structure is as follows.

Name	Type	Description
requestId	String	The request ID of the cloud product API that returned the error.
errorCode	String	The error code of the cloud product.
errorMsg	String	The error message of the cloud product.

OperationFailure.OperationFailed

Cause: The downstream cloud product returned an error and the operation failed completely.

Solution: Parse the error message and use the cloud product error code to identify the root cause.

{
     "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
     "Code": "OperationFailure.OperationFailed",
     "Message": "{
          "requestId":"432654B9-BB7F-3AE6-76CF-A5DC0DE9****",
          "errorCode": "MissingName",
          "errorMsg": "Name is mandatory for this action."
     }"
}

OperationFailure.PartialOperationFailed

Cause: The downstream cloud product returned an error and the operation partially failed.

Solution: Parse the error message and use the cloud product error code to identify the root cause.

After a partial failure, call GetResource to check the latest resource status. If needed, call UpdateResource or DeleteResource to correct the issue.

{
     "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
     "Code": "OperationFailure.PartialOperationFailed",
     "Message": "{
          "requestId":"432654B9-BB7F-3AE6-76CF-A5DC0DE9****",
          "errorCode": "InvalidRamUser.NoPermission",
          "errorMsg": "Ram user is not authorized to perform the operation."
     }"
}

Cloud Control error codes

These error codes are returned by the Cloud Control API service.

InvalidRamUser.NoPermission

Cause: The Resource Access Management (RAM) user does not have RAM authorization for the Cloud Control API.

Solution: Grant the RAM user Cloud Control API permissions by assigning a system policy or authorizing the specific API.

InvalidRamRole.NoPermission

Cause: The RAM role does not have RAM authorization for the Cloud Control API.

Solution: Grant the RAM role Cloud Control API permissions by assigning a system policy or authorizing the specific API.

InvalidResourceType.NotFound

Cause: The resource type that you entered does not exist or is not supported.

Solution: Check whether the resource type is spelled correctly and is one of the supported types.

InvalidOperation.NotSupported

Cause: The resource does not support this operation. For example, some resources do not support update or delete operations.

Solution: Do not perform this operation.

InvalidParameter.RequiredNotExisted

Cause: A required parameter is missing from the resource properties.

Solution: Add the missing property based on the error message and call the API again.

InvalidParameter.EnumCheckFailure

Cause: The value of a parameter is not within the specified enumeration range.

Solution: Adjust the property value to an allowed value based on the error message.

InvalidOperation.InvalidTaskStatus

Cause: The task cannot be canceled because its status is not Pending or Running.

Solution: You do not need to cancel this task.

InvalidOperation.TaskNotCompleted

Cause: An incomplete asynchronous task is running on the resource.

Solution: Wait for the running asynchronous task to finish. If it timed out, cancel it first, then perform the next resource operation.

InvalidRegion.NotFound

Cause: The specified region is not supported by the cloud product.

Solution: Specify a supported region and call the API again.

Throttling, Throttling.Api, and Throttling.User

Cause: Your traffic for this period has exceeded the limit.

Solution: If the current limit does not meet your business requirements, submit a ticket to request an increase.

InternalError

Cause: An internal error occurred in the Cloud Control API service.

Solution: Retry the operation. If the error persists after multiple retries, submit a ticket.

ServiceUnavailable

Cause: The Cloud Control API service is unavailable.

Solution: Retry the operation. If the error persists after multiple retries, submit a ticket.