tencent cloud

Feedback

DestroyPlan

Last updated: 2024-10-11 15:52:45

1. API Description

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

To stop billing for your EdgeOne plan, you can use this interface to terminate the billing plan.

Terminating a billing plan requires the following conditions:
1. The plan has expired (except for the Enterprise Edition Plan);
2. All sites under the plan have been either shut down or deleted.

The site status can be queried through the Query Site List interface.
A site can be deactivated by switching the site to a closed status through the Switch Site Status interface.
A site can be deleted by using the Delete Site interface.

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: DestroyPlan.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
PlanId Yes String Plan ID, in the format of edgeone-2wdo315m2y4c.

3. Output Parameters

Parameter Name Type Description
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 Terminating Billing Plan

Terminate the billing plan edgeone-2wdo315m2y4c.

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DestroyPlan
<Common request parameters>

{
    "PlanId": "edgeone-2wdo315m2y4c"
}

Output Example

{
    "Response": {
        "RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"
    }
}

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
InvalidParameter.PlanNotFound The plan doesn’t exist.
OperationDenied.DisableZoneNotCompleted The EdgeOne service of the site is being disabled. Please try again later.