RestartInstance

Last updated: 2025-11-13 20:51:21

RestartInstance

Last updated: 2025-11-13 20:51:21

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to reboot an instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: RestartInstance.
Version	Yes	String	Common Params. The value used for this API: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	Instance ID

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Async task ID
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Restarting Instances

Restarting Instances

Input Example

https://cynosdb.intl.tencentcloudapi.com/?Action=RestartInstance
&InstanceId="cynosdbmysql-ins-qwerasd"
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "347698da-03e4-4078-8d96-9a8b219c01a5",
        "FlowId": "147262"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.FlowCreateError	Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
InternalError.GetSecurityGroupDetailFailed	Failed to get the security group information.
InternalError.GetSubnetFailed	Failed to get the subnet.
InternalError.GetVpcFailed	Failed to get the VPC.
InternalError.ListInstanceFailed	Failed to query instances by security group.
InternalError.OperateWanFail	Public network operation failed.
InternalError.OperationNotSupport	Unsupported operation.
InternalError.QueryDatabaseFailed	Failed to query the database.
InternalError.SystemError	Internal system error.
InvalidParameter.IsolateNotAllowed	The current instance cannot be isolated.
InvalidParameterValue.AccountExist	The account already exists.
InvalidParameterValue.DBTypeNotFound	Unsupported instance type.
InvalidParameterValue.FlowNotFound	Taskflow ID doesn’t exist.
InvalidParameterValue.IllegalInstanceName	The instance name contains invalid characters.
InvalidParameterValue.IllegalOrderBy	Invalid sort by field.
InvalidParameterValue.IllegalPassword	The password does not meet the requirement.
InvalidParameterValue.InstanceNotFound	The instance does not exist.
InvalidParameterValue.InternalAccount	The operation is not allowed for system account.
InvalidParameterValue.InvalidDBVersion	Invalid instance version.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value.
InvalidParameterValue.InvalidSpec	Invalid instance specification.
InvalidParameterValue.ParamError	Incorrect parameter.
InvalidParameterValue.RegionZoneUnavailable	The selected region and AZ are unavailable.
InvalidParameterValue.StoragePoolNotFound	No related storage pool found.
InvalidParameterValue.SubnetNotFound	The selected subnet could not be found.
InvalidParameterValue.VpcNotFound	The selected VPC could not be found.
LimitExceeded.ClusterInstanceLimit	The node count in the cluster exceeds the maximum limit.
LimitExceeded.UserInstanceLimit	The number of instances exceeds the limit.
OperationDenied.ServerlessInstanceStatusDenied	For the serverless instance in this status, the operation is not allowed.
ResourceNotFound.InstanceNotFoundError	The instance does not exist.
ResourceUnavailable.InstanceLockFail	Failed to lock the instance, so the operation cannot be performed temporarily.
ResourceUnavailable.InstanceStatusAbnormal	The instance is exceptional, so the operation cannot be performed temporarily.
UnauthorizedOperation.NotRealNameAccount	Users who haven't completed identity verification can’t make purchases.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud