tencent cloud

DestroyPrepaidInstance
Last updated: 2024-12-04 11:19:15
DestroyPrepaidInstance
Last updated: 2024-12-04 11:19:15

1. API Description

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

This API is used to return Redis instances with monthly subscription.

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: DestroyPrepaidInstance.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID. Log in to the Redis console and copy it in the instance list.

3. Output Parameters

Parameter Name Type Description
DealId String Order 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 Returning monthly subscribed instance

Input Example

https://redis.intl.tencentcloudapi.com/?Action=DestroyPrepaidInstance
&InstanceId=crs-5a4py64p
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4",
        "DealId": "6977675"
    }
}

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.SystemError Internal system error, which is irrelevant to the business.
FailedOperation.Unknown Invalid data is entered for weekday.
InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
InternalError.InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue.UnSupportedType The instance type is not supported.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
ResourceUnavailable.InstanceDeleted The instance has already been repossessed.
ResourceUnavailable.InstanceIsolated The instance has expired.
ResourceUnavailable.InstanceNoDeal The order does not exist.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback