tencent cloud

文档反馈

RestartInstance

最后更新时间:2023-08-23 14:23:00

1. API Description

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

This API is used to restart 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.
InstanceId Yes String Instance ID

3. Output Parameters

Parameter Name Type Description
FlowId Integer Async task ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Restarting an instance

Input Example

https://cynosdb.tencentcloudapi.com/?Action=RestartInstance
&InstanceId=xxx
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "128046",
        "FlowId": "123"
    }
}

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

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.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持